| id required | string <JSON> User id |
| fk required | string <JSON> Foreign key for accessTokens |
{- "id": "string",
- "ttl": 1209600,
- "scopes": [
- "string"
], - "created": "2019-08-24T14:15:22Z",
- "userId": "string"
}| id required | string <JSON> User id |
| fk required | string <JSON> Foreign key for accessTokens |
| id required | string |
| ttl | number <double> Default: 1209600 time to live in seconds (2 weeks by default) |
| scopes | Array of strings Array of scopes granted to this access token. |
| created | string <date-time> |
| userId | string (ObjectID) ^[a-fA-F\d]{24}$ |
{- "id": "string",
- "ttl": 1209600,
- "scopes": [
- "string"
], - "created": "2019-08-24T14:15:22Z",
- "userId": "string"
}{- "id": "string",
- "ttl": 1209600,
- "scopes": [
- "string"
], - "created": "2019-08-24T14:15:22Z",
- "userId": "string"
}| id required | string <JSON> User id |
| refresh | boolean |
{- "columns": [
- { }
], - "datasetCount": 25,
- "jobCount": 25,
- "id": "string",
- "userId": "string"
}| id required | string <JSON> User id |
| columns | Array of objects |
| datasetCount | number <double> Default: 25 |
| jobCount | number <double> Default: 25 |
| id | string (ObjectID) ^[a-fA-F\d]{24}$ |
| userId | string (ObjectID) ^[a-fA-F\d]{24}$ |
{- "columns": [
- { }
], - "datasetCount": 25,
- "jobCount": 25,
- "id": "string",
- "userId": "string"
}{- "columns": [
- { }
], - "datasetCount": 25,
- "jobCount": 25,
- "id": "string",
- "userId": "string"
}| id required | string <JSON> User id |
| columns | Array of objects |
| datasetCount | number <double> Default: 25 |
| jobCount | number <double> Default: 25 |
| id | string (ObjectID) ^[a-fA-F\d]{24}$ |
| userId | string (ObjectID) ^[a-fA-F\d]{24}$ |
{- "columns": [
- { }
], - "datasetCount": 25,
- "jobCount": 25,
- "id": "string",
- "userId": "string"
}{- "columns": [
- { }
], - "datasetCount": 25,
- "jobCount": 25,
- "id": "string",
- "userId": "string"
}| id required | string <JSON> User id |
| fk required | string <JSON> Foreign key for identities |
{- "id": 0,
- "userId": "string"
}| id required | string <JSON> User id |
| fk required | string <JSON> Foreign key for identities |
| id | number <double> |
| userId | string (ObjectID) ^[a-fA-F\d]{24}$ |
{- "id": 0,
- "userId": "string"
}{- "id": 0,
- "userId": "string"
}| id required | string <JSON> User id |
| fk required | string <JSON> Foreign key for credentials |
{- "provider": "string",
- "authScheme": "string",
- "externalId": "string",
- "profile": { },
- "credentials": { },
- "created": "2019-08-24T14:15:22Z",
- "modified": "2019-08-24T14:15:22Z",
- "id": "string",
- "userId": "string"
}| id required | string <JSON> User id |
| fk required | string <JSON> Foreign key for credentials |
| provider | string |
| authScheme | string |
| externalId | string |
| profile | object |
| credentials | object |
| created | string <date-time> |
| modified | string <date-time> |
| id | string (ObjectID) ^[a-fA-F\d]{24}$ |
| userId | string (ObjectID) ^[a-fA-F\d]{24}$ |
{- "provider": "string",
- "authScheme": "string",
- "externalId": "string",
- "profile": { },
- "credentials": { },
- "created": "2019-08-24T14:15:22Z",
- "modified": "2019-08-24T14:15:22Z",
- "id": "string",
- "userId": "string"
}{- "provider": "string",
- "authScheme": "string",
- "externalId": "string",
- "profile": { },
- "credentials": { },
- "created": "2019-08-24T14:15:22Z",
- "modified": "2019-08-24T14:15:22Z",
- "id": "string",
- "userId": "string"
}| id required | string <JSON> User id |
| filter | string <JSON> |
[- {
- "id": "string",
- "ttl": 1209600,
- "scopes": [
- "string"
], - "created": "2019-08-24T14:15:22Z",
- "userId": "string"
}
]| id required | string <JSON> User id |
| id required | string |
| ttl | number <double> Default: 1209600 time to live in seconds (2 weeks by default) |
| scopes | Array of strings Array of scopes granted to this access token. |
| created | string <date-time> |
| userId | string (ObjectID) ^[a-fA-F\d]{24}$ |
{- "id": "string",
- "ttl": 1209600,
- "scopes": [
- "string"
], - "created": "2019-08-24T14:15:22Z",
- "userId": "string"
}{- "id": "string",
- "ttl": 1209600,
- "scopes": [
- "string"
], - "created": "2019-08-24T14:15:22Z",
- "userId": "string"
}| id required | string <JSON> User id |
| id | number <double> |
| userId | string (ObjectID) ^[a-fA-F\d]{24}$ |
{- "id": 0,
- "userId": "string"
}{- "id": 0,
- "userId": "string"
}| id required | string <JSON> User id |
| filter | string <JSON> |
[- {
- "provider": "string",
- "authScheme": "string",
- "externalId": "string",
- "profile": { },
- "credentials": { },
- "created": "2019-08-24T14:15:22Z",
- "modified": "2019-08-24T14:15:22Z",
- "id": "string",
- "userId": "string"
}
]| id required | string <JSON> User id |
| provider | string |
| authScheme | string |
| externalId | string |
| profile | object |
| credentials | object |
| created | string <date-time> |
| modified | string <date-time> |
| id | string (ObjectID) ^[a-fA-F\d]{24}$ |
| userId | string (ObjectID) ^[a-fA-F\d]{24}$ |
{- "provider": "string",
- "authScheme": "string",
- "externalId": "string",
- "profile": { },
- "credentials": { },
- "created": "2019-08-24T14:15:22Z",
- "modified": "2019-08-24T14:15:22Z",
- "id": "string",
- "userId": "string"
}{- "provider": "string",
- "authScheme": "string",
- "externalId": "string",
- "profile": { },
- "credentials": { },
- "created": "2019-08-24T14:15:22Z",
- "modified": "2019-08-24T14:15:22Z",
- "id": "string",
- "userId": "string"
}Model instance data
| realm | string |
| username | string |
| email required | string |
| emailVerified | boolean |
| id | string (ObjectID) ^[a-fA-F\d]{24}$ |
{- "realm": "string",
- "username": "string",
- "email": "string",
- "emailVerified": true,
- "id": "string"
}{- "realm": "string",
- "username": "string",
- "email": "string",
- "emailVerified": true,
- "id": "string"
}Model instance data
| realm | string |
| username | string |
| email required | string |
| emailVerified | boolean |
| id | string (ObjectID) ^[a-fA-F\d]{24}$ |
{- "realm": "string",
- "username": "string",
- "email": "string",
- "emailVerified": true,
- "id": "string"
}{- "realm": "string",
- "username": "string",
- "email": "string",
- "emailVerified": true,
- "id": "string"
}Model instance data
| realm | string |
| username | string |
| email required | string |
| emailVerified | boolean |
| id | string (ObjectID) ^[a-fA-F\d]{24}$ |
{- "realm": "string",
- "username": "string",
- "email": "string",
- "emailVerified": true,
- "id": "string"
}{- "realm": "string",
- "username": "string",
- "email": "string",
- "emailVerified": true,
- "id": "string"
}| filter | string <JSON> Filter defining fields, where, include, order, offset, and limit - must be a JSON-encoded string ( |
[- {
- "realm": "string",
- "username": "string",
- "email": "string",
- "emailVerified": true,
- "id": "string"
}
]Model instance data
| realm | string |
| username | string |
| email required | string |
| emailVerified | boolean |
| id | string (ObjectID) ^[a-fA-F\d]{24}$ |
{- "realm": "string",
- "username": "string",
- "email": "string",
- "emailVerified": true,
- "id": "string"
}{- "realm": "string",
- "username": "string",
- "email": "string",
- "emailVerified": true,
- "id": "string"
}| where | string <JSON> Criteria to match model instances |
An object of model property name/value pairs
| realm | string |
| username | string |
| email required | string |
| emailVerified | boolean |
| id | string (ObjectID) ^[a-fA-F\d]{24}$ |
{- "realm": "string",
- "username": "string",
- "email": "string",
- "emailVerified": true,
- "id": "string"
}{- "realm": "string",
- "username": "string",
- "email": "string",
- "emailVerified": true,
- "id": "string"
}| id required | string <JSON> Model id |
| filter | string <JSON> Filter defining fields and include - must be a JSON-encoded string ({"something":"value"}) |
{- "realm": "string",
- "username": "string",
- "email": "string",
- "emailVerified": true,
- "id": "string"
}| id required | string <JSON> Model id |
Model instance data
| realm | string |
| username | string |
| email required | string |
| emailVerified | boolean |
| id | string (ObjectID) ^[a-fA-F\d]{24}$ |
{- "realm": "string",
- "username": "string",
- "email": "string",
- "emailVerified": true,
- "id": "string"
}{- "realm": "string",
- "username": "string",
- "email": "string",
- "emailVerified": true,
- "id": "string"
}| id required | string <JSON> User id |
An object of model property name/value pairs
| realm | string |
| username | string |
| email required | string |
| emailVerified | boolean |
| id | string (ObjectID) ^[a-fA-F\d]{24}$ |
{- "realm": "string",
- "username": "string",
- "email": "string",
- "emailVerified": true,
- "id": "string"
}{- "realm": "string",
- "username": "string",
- "email": "string",
- "emailVerified": true,
- "id": "string"
}| id required | string <JSON> Model id |
Model instance data
| realm | string |
| username | string |
| email required | string |
| emailVerified | boolean |
| id | string (ObjectID) ^[a-fA-F\d]{24}$ |
{- "realm": "string",
- "username": "string",
- "email": "string",
- "emailVerified": true,
- "id": "string"
}{- "realm": "string",
- "username": "string",
- "email": "string",
- "emailVerified": true,
- "id": "string"
}| filter | string <JSON> Filter defining fields, where, include, order, offset, and limit - must be a JSON-encoded string ( |
{- "realm": "string",
- "username": "string",
- "email": "string",
- "emailVerified": true,
- "id": "string"
}| where | string <JSON> Criteria to match model instances |
An object of model property name/value pairs
| realm | string |
| username | string |
| email required | string |
| emailVerified | boolean |
| id | string (ObjectID) ^[a-fA-F\d]{24}$ |
{- "realm": "string",
- "username": "string",
- "email": "string",
- "emailVerified": true,
- "id": "string"
}{- "count": 0
}| include | string <JSON> Related objects to include in the response. See the description of return value for more details. |
{ }{ }Stores the meta data information for a given collection of files. It defines a list of mandatory and optional metadata fields to be defined. Datasets have a PID field for unique identification. This is the base 'class' for derived documents like raw datasets or derived datasets. The type field is used to distinguish between the different types of datasets. For each dataset in addition an embedded DatasetLifecycle is created. However the definition of which files belong to a given dataset is defined in an extra OrigDatablock collection.
| id required | string <JSON> Dataset id |
| fk required | string <JSON> Foreign key for samples |
{- "sampleId": "string",
- "owner": "string",
- "description": "string",
- "createdAt": "2019-08-24T14:15:22Z",
- "sampleCharacteristics": { },
- "isPublished": true,
- "ownerGroup": "string",
- "accessGroups": [
- "string"
], - "createdBy": "string",
- "updatedBy": "string",
- "datasetsId": "string",
- "datasetId": "string",
- "rawDatasetId": "string",
- "derivedDatasetId": "string",
- "updatedAt": "2019-08-24T14:15:22Z"
}| id required | string <JSON> Dataset id |
| fk required | string <JSON> Foreign key for samples |
| sampleId required | string |
| owner | string |
| description | string |
| createdAt | string <date-time> |
| sampleCharacteristics | object |
| isPublished | boolean Flag is true when data are made publically available |
| ownerGroup required | string Defines the group which owns the data, and therefore has unrestricted access to this data. Usually a pgroup like p12151 |
| accessGroups | Array of strings Optional additional groups which have read access to the data. Users which are member in one of the groups listed here are allowed to access this data. The special group 'public' makes data available to all users |
| createdBy | string Functional or user account name who created this instance |
| updatedBy | string Functional or user account name who last updated this instance |
| datasetsId | string |
| datasetId | string |
| rawDatasetId | string |
| derivedDatasetId | string |
| updatedAt | string <date-time> |
{- "sampleId": "string",
- "owner": "string",
- "description": "string",
- "createdAt": "2019-08-24T14:15:22Z",
- "sampleCharacteristics": { },
- "isPublished": true,
- "ownerGroup": "string",
- "accessGroups": [
- "string"
], - "createdBy": "string",
- "updatedBy": "string",
- "datasetsId": "string",
- "datasetId": "string",
- "rawDatasetId": "string",
- "derivedDatasetId": "string",
- "updatedAt": "2019-08-24T14:15:22Z"
}{- "sampleId": "string",
- "owner": "string",
- "description": "string",
- "createdAt": "2019-08-24T14:15:22Z",
- "sampleCharacteristics": { },
- "isPublished": true,
- "ownerGroup": "string",
- "accessGroups": [
- "string"
], - "createdBy": "string",
- "updatedBy": "string",
- "datasetsId": "string",
- "datasetId": "string",
- "rawDatasetId": "string",
- "derivedDatasetId": "string",
- "updatedAt": "2019-08-24T14:15:22Z"
}| id required | string <JSON> Dataset id |
| refresh | boolean |
{- "doi": "string",
- "affiliation": "string",
- "creator": [
- "string"
], - "publisher": "string",
- "publicationYear": 0,
- "title": "string",
- "url": "string",
- "abstract": "string",
- "dataDescription": "string",
- "resourceType": "string",
- "numberOfFiles": 0,
- "sizeOfArchive": 0,
- "pidArray": [
- "string"
], - "authors": [
- "string"
], - "registeredTime": "2019-08-24T14:15:22Z",
- "status": "string",
- "scicatUser": "string",
- "thumbnail": "string",
- "relatedPublications": [
- "string"
], - "downloadLink": "string",
- "createdBy": "string",
- "updatedBy": "string",
- "createdAt": "2019-08-24T14:15:22Z",
- "updatedAt": "2019-08-24T14:15:22Z"
}| id required | string <JSON> Dataset id |
| refresh | boolean |
{- "archivable": true,
- "retrievable": true,
- "publishable": true,
- "dateOfDiskPurging": "2019-08-24T14:15:22Z",
- "archiveRetentionTime": "2019-08-24T14:15:22Z",
- "dateOfPublishing": "2019-08-24T14:15:22Z",
- "isOnCentralDisk": true,
- "archiveStatusMessage": "string",
- "retrieveStatusMessage": "string",
- "archiveReturnMessage": { },
- "retrieveReturnMessage": { },
- "exportedTo": "string",
- "retrieveIntegrityCheck": true,
- "id": "string"
}| id required | string <JSON> Dataset id |
| archivable | boolean Flag which is true, if dataset is available to be archived and no archive job for this dataset exists yet. |
| retrievable | boolean Flag which is true, if dataset is stored on archive system and is ready to be retrieved. |
| publishable | boolean Flag which is true, if dataset can be published. Usually requires a longterm storage option on tape or similar. |
| dateOfDiskPurging | string <date-time> Day when dataset will be removed from disk, assuming that is already stored on tape. |
| archiveRetentionTime | string <date-time> Day when the dataset's future fate will be evaluated again, e.g. to decide if the dataset can be deleted from archive. |
| dateOfPublishing | string <date-time> Day when dataset is supposed to become public according to data policy |
| isOnCentralDisk | boolean Flag which is true, if full dataset is available on central fileserver. If false data needs to be copied from decentral storage place to a cache server before the ingest. This information needs to be transferred to the archive system at archive time |
| archiveStatusMessage | string Short string defining current status of Dataset with respect to storage on disk/tape. |
| retrieveStatusMessage | string Latest message for this dataset concerning retrieve from archive system. |
| archiveReturnMessage | object Detailed status or error message returned by archive system when archiving this dataset. |
| retrieveReturnMessage | object Detailed status or error message returned by archive system when retrieving this dataset. |
| exportedTo | string Location of the last export destination. |
| retrieveIntegrityCheck | boolean Set to true when checksum tests after retrieve of datasets were successful |
| id | string |
{- "archivable": true,
- "retrievable": true,
- "publishable": true,
- "dateOfDiskPurging": "2019-08-24T14:15:22Z",
- "archiveRetentionTime": "2019-08-24T14:15:22Z",
- "dateOfPublishing": "2019-08-24T14:15:22Z",
- "isOnCentralDisk": true,
- "archiveStatusMessage": "string",
- "retrieveStatusMessage": "string",
- "archiveReturnMessage": { },
- "retrieveReturnMessage": { },
- "exportedTo": "string",
- "retrieveIntegrityCheck": true,
- "id": "string"
}{- "archivable": true,
- "retrievable": true,
- "publishable": true,
- "dateOfDiskPurging": "2019-08-24T14:15:22Z",
- "archiveRetentionTime": "2019-08-24T14:15:22Z",
- "dateOfPublishing": "2019-08-24T14:15:22Z",
- "isOnCentralDisk": true,
- "archiveStatusMessage": "string",
- "retrieveStatusMessage": "string",
- "archiveReturnMessage": { },
- "retrieveReturnMessage": { },
- "exportedTo": "string",
- "retrieveIntegrityCheck": true,
- "id": "string"
}| id required | string <JSON> Dataset id |
| archivable | boolean Flag which is true, if dataset is available to be archived and no archive job for this dataset exists yet. |
| retrievable | boolean Flag which is true, if dataset is stored on archive system and is ready to be retrieved. |
| publishable | boolean Flag which is true, if dataset can be published. Usually requires a longterm storage option on tape or similar. |
| dateOfDiskPurging | string <date-time> Day when dataset will be removed from disk, assuming that is already stored on tape. |
| archiveRetentionTime | string <date-time> Day when the dataset's future fate will be evaluated again, e.g. to decide if the dataset can be deleted from archive. |
| dateOfPublishing | string <date-time> Day when dataset is supposed to become public according to data policy |
| isOnCentralDisk | boolean Flag which is true, if full dataset is available on central fileserver. If false data needs to be copied from decentral storage place to a cache server before the ingest. This information needs to be transferred to the archive system at archive time |
| archiveStatusMessage | string Short string defining current status of Dataset with respect to storage on disk/tape. |
| retrieveStatusMessage | string Latest message for this dataset concerning retrieve from archive system. |
| archiveReturnMessage | object Detailed status or error message returned by archive system when archiving this dataset. |
| retrieveReturnMessage | object Detailed status or error message returned by archive system when retrieving this dataset. |
| exportedTo | string Location of the last export destination. |
| retrieveIntegrityCheck | boolean Set to true when checksum tests after retrieve of datasets were successful |
| id | string |
{- "archivable": true,
- "retrievable": true,
- "publishable": true,
- "dateOfDiskPurging": "2019-08-24T14:15:22Z",
- "archiveRetentionTime": "2019-08-24T14:15:22Z",
- "dateOfPublishing": "2019-08-24T14:15:22Z",
- "isOnCentralDisk": true,
- "archiveStatusMessage": "string",
- "retrieveStatusMessage": "string",
- "archiveReturnMessage": { },
- "retrieveReturnMessage": { },
- "exportedTo": "string",
- "retrieveIntegrityCheck": true,
- "id": "string"
}{- "archivable": true,
- "retrievable": true,
- "publishable": true,
- "dateOfDiskPurging": "2019-08-24T14:15:22Z",
- "archiveRetentionTime": "2019-08-24T14:15:22Z",
- "dateOfPublishing": "2019-08-24T14:15:22Z",
- "isOnCentralDisk": true,
- "archiveStatusMessage": "string",
- "retrieveStatusMessage": "string",
- "archiveReturnMessage": { },
- "retrieveReturnMessage": { },
- "exportedTo": "string",
- "retrieveIntegrityCheck": true,
- "id": "string"
}| id required | string <JSON> Dataset id |
| fk required | string <JSON> Foreign key for datablocks |
{- "id": "string",
- "archiveId": "string",
- "size": 0,
- "packedSize": 0,
- "chkAlg": "string",
- "version": "string",
- "dataFileList": [
- {
- "path": "string",
- "size": 0,
- "time": "2019-08-24T14:15:22Z",
- "chk": "string",
- "uid": "string",
- "gid": "string",
- "perm": "string"
}
], - "ownerGroup": "string",
- "accessGroups": [
- "string"
], - "createdBy": "string",
- "updatedBy": "string",
- "datasetId": "string",
- "rawDatasetId": "string",
- "derivedDatasetId": "string",
- "createdAt": "2019-08-24T14:15:22Z",
- "updatedAt": "2019-08-24T14:15:22Z"
}| id required | string <JSON> Dataset id |
| fk required | string <JSON> Foreign key for datablocks |
| id required | string Catalog internal UUIDv4 for datablock |
| archiveId required | string Unique identifier given bey archive system to the stored datablock. This id is used when data is retrieved back. |
| size required | number <double> Total size in bytes of all files in datablock when unpacked |
| packedSize | number <double> Size of datablock package file |
| chkAlg | string Algoritm used for calculation of checksums, e.g. sha2 |
| version required | string Version string defining format of how data is packed and stored in archive |
required | Array of objects (Datafile) |
| ownerGroup required | string Defines the group which owns the data, and therefore has unrestricted access to this data. Usually a pgroup like p12151 |
| accessGroups | Array of strings Optional additional groups which have read access to the data. Users which are member in one of the groups listed here are allowed to access this data. The special group 'public' makes data available to all users |
| createdBy | string Functional or user account name who created this instance |
| updatedBy | string Functional or user account name who last updated this instance |
| datasetId | string |
| rawDatasetId | string |
| derivedDatasetId | string |
| createdAt | string <date-time> |
| updatedAt | string <date-time> |
{- "id": "string",
- "archiveId": "string",
- "size": 0,
- "packedSize": 0,
- "chkAlg": "string",
- "version": "string",
- "dataFileList": [
- {
- "path": "string",
- "size": 0,
- "time": "2019-08-24T14:15:22Z",
- "chk": "string",
- "uid": "string",
- "gid": "string",
- "perm": "string"
}
], - "ownerGroup": "string",
- "accessGroups": [
- "string"
], - "createdBy": "string",
- "updatedBy": "string",
- "datasetId": "string",
- "rawDatasetId": "string",
- "derivedDatasetId": "string",
- "createdAt": "2019-08-24T14:15:22Z",
- "updatedAt": "2019-08-24T14:15:22Z"
}{- "id": "string",
- "archiveId": "string",
- "size": 0,
- "packedSize": 0,
- "chkAlg": "string",
- "version": "string",
- "dataFileList": [
- {
- "path": "string",
- "size": 0,
- "time": "2019-08-24T14:15:22Z",
- "chk": "string",
- "uid": "string",
- "gid": "string",
- "perm": "string"
}
], - "ownerGroup": "string",
- "accessGroups": [
- "string"
], - "createdBy": "string",
- "updatedBy": "string",
- "datasetId": "string",
- "rawDatasetId": "string",
- "derivedDatasetId": "string",
- "createdAt": "2019-08-24T14:15:22Z",
- "updatedAt": "2019-08-24T14:15:22Z"
}| id required | string <JSON> Dataset id |
| fk required | string <JSON> Foreign key for origdatablocks |
{- "id": "string",
- "size": 0,
- "dataFileList": [
- {
- "path": "string",
- "size": 0,
- "time": "2019-08-24T14:15:22Z",
- "chk": "string",
- "uid": "string",
- "gid": "string",
- "perm": "string"
}
], - "ownerGroup": "string",
- "accessGroups": [
- "string"
], - "createdBy": "string",
- "updatedBy": "string",
- "datasetId": "string",
- "rawDatasetId": "string",
- "derivedDatasetId": "string",
- "createdAt": "2019-08-24T14:15:22Z",
- "updatedAt": "2019-08-24T14:15:22Z"
}| id required | string <JSON> Dataset id |
| fk required | string <JSON> Foreign key for origdatablocks |
| id | string (ObjectID) ^[a-fA-F\d]{24}$ |
| size required | number <double> Total size in bytes of all files contained in the dataFileList |
required | Array of objects (Datafile) List of files contained in the linked dataset. Files can be regular files, folders and softlinks. All file paths are relative paths with respect to the sourceFolder location of the linked dataset. |
| ownerGroup required | string Defines the group which owns the data, and therefore has unrestricted access to this data. Usually a pgroup like p12151 |
| accessGroups | Array of strings Optional additional groups which have read access to the data. Users which are member in one of the groups listed here are allowed to access this data. The special group 'public' makes data available to all users |
| createdBy | string Functional or user account name who created this instance |
| updatedBy | string Functional or user account name who last updated this instance |
| datasetId | string |
| rawDatasetId | string |
| derivedDatasetId | string |
| createdAt | string <date-time> |
| updatedAt | string <date-time> |
{- "id": "string",
- "size": 0,
- "dataFileList": [
- {
- "path": "string",
- "size": 0,
- "time": "2019-08-24T14:15:22Z",
- "chk": "string",
- "uid": "string",
- "gid": "string",
- "perm": "string"
}
], - "ownerGroup": "string",
- "accessGroups": [
- "string"
], - "createdBy": "string",
- "updatedBy": "string",
- "datasetId": "string",
- "rawDatasetId": "string",
- "derivedDatasetId": "string",
- "createdAt": "2019-08-24T14:15:22Z",
- "updatedAt": "2019-08-24T14:15:22Z"
}{- "id": "string",
- "size": 0,
- "dataFileList": [
- {
- "path": "string",
- "size": 0,
- "time": "2019-08-24T14:15:22Z",
- "chk": "string",
- "uid": "string",
- "gid": "string",
- "perm": "string"
}
], - "ownerGroup": "string",
- "accessGroups": [
- "string"
], - "createdBy": "string",
- "updatedBy": "string",
- "datasetId": "string",
- "rawDatasetId": "string",
- "derivedDatasetId": "string",
- "createdAt": "2019-08-24T14:15:22Z",
- "updatedAt": "2019-08-24T14:15:22Z"
}| id required | string <JSON> Dataset id |
| fk required | string <JSON> Foreign key for historyList |
| id required | string id currently needed by limitation in embedsmany |
{- "id": "string"
}{- "id": "string"
}| id required | string <JSON> Dataset id |
| fk required | string <JSON> Foreign key for attachments |
{- "thumbnail": "retrieve",
- "caption": "",
- "ownerGroup": "string",
- "accessGroups": [
- "string"
], - "createdBy": "string",
- "updatedBy": "string",
- "id": "string",
- "datasetId": "string",
- "sampleId": "string",
- "proposalId": "string",
- "rawDatasetId": "string",
- "derivedDatasetId": "string",
- "createdAt": "2019-08-24T14:15:22Z",
- "updatedAt": "2019-08-24T14:15:22Z"
}| id required | string <JSON> Dataset id |
| fk required | string <JSON> Foreign key for attachments |
| thumbnail required | string Default: "retrieve" Contains a thumbnail preview in base64 encoded png format for a given dataset |
| caption | string Default: "" Attachment caption to show in catanie |
| ownerGroup required | string Defines the group which owns the data, and therefore has unrestricted access to this data. Usually a pgroup like p12151 |
| accessGroups | Array of strings Optional additional groups which have read access to the data. Users which are member in one of the groups listed here are allowed to access this data. The special group 'public' makes data available to all users |
| createdBy | string Functional or user account name who created this instance |
| updatedBy | string Functional or user account name who last updated this instance |
| id | string (ObjectID) ^[a-fA-F\d]{24}$ |
| datasetId | string |
| sampleId | string |
| proposalId | string |
| rawDatasetId | string |
| derivedDatasetId | string |
| createdAt | string <date-time> |
| updatedAt | string <date-time> |
{- "thumbnail": "retrieve",
- "caption": "",
- "ownerGroup": "string",
- "accessGroups": [
- "string"
], - "createdBy": "string",
- "updatedBy": "string",
- "id": "string",
- "datasetId": "string",
- "sampleId": "string",
- "proposalId": "string",
- "rawDatasetId": "string",
- "derivedDatasetId": "string",
- "createdAt": "2019-08-24T14:15:22Z",
- "updatedAt": "2019-08-24T14:15:22Z"
}{- "thumbnail": "retrieve",
- "caption": "",
- "ownerGroup": "string",
- "accessGroups": [
- "string"
], - "createdBy": "string",
- "updatedBy": "string",
- "id": "string",
- "datasetId": "string",
- "sampleId": "string",
- "proposalId": "string",
- "rawDatasetId": "string",
- "derivedDatasetId": "string",
- "createdAt": "2019-08-24T14:15:22Z",
- "updatedAt": "2019-08-24T14:15:22Z"
}| id required | string <JSON> Dataset id |
| refresh | boolean |
{- "pid": "string",
- "name": "string",
- "customMetadata": { }
}| id required | string <JSON> Dataset id |
| fk required | string <JSON> Foreign key for techniquesList |
{- "pid": "string",
- "name": "string"
}| id required | string <JSON> Dataset id |
| fk required | string <JSON> Foreign key for techniquesList |
| pid required | string Persistent Identifier dervied from UUIDv4 |
| name required | string The name of the technique |
{- "pid": "string",
- "name": "string"
}{- "pid": "string",
- "name": "string"
}| id required | string <JSON> Dataset id |
| filter | string <JSON> |
[- {
- "sampleId": "string",
- "owner": "string",
- "description": "string",
- "createdAt": "2019-08-24T14:15:22Z",
- "sampleCharacteristics": { },
- "isPublished": true,
- "ownerGroup": "string",
- "accessGroups": [
- "string"
], - "createdBy": "string",
- "updatedBy": "string",
- "datasetsId": "string",
- "datasetId": "string",
- "rawDatasetId": "string",
- "derivedDatasetId": "string",
- "updatedAt": "2019-08-24T14:15:22Z"
}
]| id required | string <JSON> Dataset id |
| sampleId required | string |
| owner | string |
| description | string |
| createdAt | string <date-time> |
| sampleCharacteristics | object |
| isPublished | boolean Flag is true when data are made publically available |
| ownerGroup required | string Defines the group which owns the data, and therefore has unrestricted access to this data. Usually a pgroup like p12151 |
| accessGroups | Array of strings Optional additional groups which have read access to the data. Users which are member in one of the groups listed here are allowed to access this data. The special group 'public' makes data available to all users |
| createdBy | string Functional or user account name who created this instance |
| updatedBy | string Functional or user account name who last updated this instance |
| datasetsId | string |
| datasetId | string |
| rawDatasetId | string |
| derivedDatasetId | string |
| updatedAt | string <date-time> |
{- "sampleId": "string",
- "owner": "string",
- "description": "string",
- "createdAt": "2019-08-24T14:15:22Z",
- "sampleCharacteristics": { },
- "isPublished": true,
- "ownerGroup": "string",
- "accessGroups": [
- "string"
], - "createdBy": "string",
- "updatedBy": "string",
- "datasetsId": "string",
- "datasetId": "string",
- "rawDatasetId": "string",
- "derivedDatasetId": "string",
- "updatedAt": "2019-08-24T14:15:22Z"
}{- "sampleId": "string",
- "owner": "string",
- "description": "string",
- "createdAt": "2019-08-24T14:15:22Z",
- "sampleCharacteristics": { },
- "isPublished": true,
- "ownerGroup": "string",
- "accessGroups": [
- "string"
], - "createdBy": "string",
- "updatedBy": "string",
- "datasetsId": "string",
- "datasetId": "string",
- "rawDatasetId": "string",
- "derivedDatasetId": "string",
- "updatedAt": "2019-08-24T14:15:22Z"
}| id required | string <JSON> Dataset id |
| filter | string <JSON> |
[- {
- "id": "string",
- "archiveId": "string",
- "size": 0,
- "packedSize": 0,
- "chkAlg": "string",
- "version": "string",
- "dataFileList": [
- {
- "path": "string",
- "size": 0,
- "time": "2019-08-24T14:15:22Z",
- "chk": "string",
- "uid": "string",
- "gid": "string",
- "perm": "string"
}
], - "ownerGroup": "string",
- "accessGroups": [
- "string"
], - "createdBy": "string",
- "updatedBy": "string",
- "datasetId": "string",
- "rawDatasetId": "string",
- "derivedDatasetId": "string",
- "createdAt": "2019-08-24T14:15:22Z",
- "updatedAt": "2019-08-24T14:15:22Z"
}
]| id required | string <JSON> Dataset id |
| id required | string Catalog internal UUIDv4 for datablock |
| archiveId required | string Unique identifier given bey archive system to the stored datablock. This id is used when data is retrieved back. |
| size required | number <double> Total size in bytes of all files in datablock when unpacked |
| packedSize | number <double> Size of datablock package file |
| chkAlg | string Algoritm used for calculation of checksums, e.g. sha2 |
| version required | string Version string defining format of how data is packed and stored in archive |
required | Array of objects (Datafile) |
| ownerGroup required | string Defines the group which owns the data, and therefore has unrestricted access to this data. Usually a pgroup like p12151 |
| accessGroups | Array of strings Optional additional groups which have read access to the data. Users which are member in one of the groups listed here are allowed to access this data. The special group 'public' makes data available to all users |
| createdBy | string Functional or user account name who created this instance |
| updatedBy | string Functional or user account name who last updated this instance |
| datasetId | string |
| rawDatasetId | string |
| derivedDatasetId | string |
| createdAt | string <date-time> |
| updatedAt | string <date-time> |
{- "id": "string",
- "archiveId": "string",
- "size": 0,
- "packedSize": 0,
- "chkAlg": "string",
- "version": "string",
- "dataFileList": [
- {
- "path": "string",
- "size": 0,
- "time": "2019-08-24T14:15:22Z",
- "chk": "string",
- "uid": "string",
- "gid": "string",
- "perm": "string"
}
], - "ownerGroup": "string",
- "accessGroups": [
- "string"
], - "createdBy": "string",
- "updatedBy": "string",
- "datasetId": "string",
- "rawDatasetId": "string",
- "derivedDatasetId": "string",
- "createdAt": "2019-08-24T14:15:22Z",
- "updatedAt": "2019-08-24T14:15:22Z"
}{- "id": "string",
- "archiveId": "string",
- "size": 0,
- "packedSize": 0,
- "chkAlg": "string",
- "version": "string",
- "dataFileList": [
- {
- "path": "string",
- "size": 0,
- "time": "2019-08-24T14:15:22Z",
- "chk": "string",
- "uid": "string",
- "gid": "string",
- "perm": "string"
}
], - "ownerGroup": "string",
- "accessGroups": [
- "string"
], - "createdBy": "string",
- "updatedBy": "string",
- "datasetId": "string",
- "rawDatasetId": "string",
- "derivedDatasetId": "string",
- "createdAt": "2019-08-24T14:15:22Z",
- "updatedAt": "2019-08-24T14:15:22Z"
}| id required | string <JSON> Dataset id |
| filter | string <JSON> |
[- {
- "id": "string",
- "size": 0,
- "dataFileList": [
- {
- "path": "string",
- "size": 0,
- "time": "2019-08-24T14:15:22Z",
- "chk": "string",
- "uid": "string",
- "gid": "string",
- "perm": "string"
}
], - "ownerGroup": "string",
- "accessGroups": [
- "string"
], - "createdBy": "string",
- "updatedBy": "string",
- "datasetId": "string",
- "rawDatasetId": "string",
- "derivedDatasetId": "string",
- "createdAt": "2019-08-24T14:15:22Z",
- "updatedAt": "2019-08-24T14:15:22Z"
}
]| id required | string <JSON> Dataset id |
| id | string (ObjectID) ^[a-fA-F\d]{24}$ |
| size required | number <double> Total size in bytes of all files contained in the dataFileList |
required | Array of objects (Datafile) List of files contained in the linked dataset. Files can be regular files, folders and softlinks. All file paths are relative paths with respect to the sourceFolder location of the linked dataset. |
| ownerGroup required | string Defines the group which owns the data, and therefore has unrestricted access to this data. Usually a pgroup like p12151 |
| accessGroups | Array of strings Optional additional groups which have read access to the data. Users which are member in one of the groups listed here are allowed to access this data. The special group 'public' makes data available to all users |
| createdBy | string Functional or user account name who created this instance |
| updatedBy | string Functional or user account name who last updated this instance |
| datasetId | string |
| rawDatasetId | string |
| derivedDatasetId | string |
| createdAt | string <date-time> |
| updatedAt | string <date-time> |
{- "id": "string",
- "size": 0,
- "dataFileList": [
- {
- "path": "string",
- "size": 0,
- "time": "2019-08-24T14:15:22Z",
- "chk": "string",
- "uid": "string",
- "gid": "string",
- "perm": "string"
}
], - "ownerGroup": "string",
- "accessGroups": [
- "string"
], - "createdBy": "string",
- "updatedBy": "string",
- "datasetId": "string",
- "rawDatasetId": "string",
- "derivedDatasetId": "string",
- "createdAt": "2019-08-24T14:15:22Z",
- "updatedAt": "2019-08-24T14:15:22Z"
}{- "id": "string",
- "size": 0,
- "dataFileList": [
- {
- "path": "string",
- "size": 0,
- "time": "2019-08-24T14:15:22Z",
- "chk": "string",
- "uid": "string",
- "gid": "string",
- "perm": "string"
}
], - "ownerGroup": "string",
- "accessGroups": [
- "string"
], - "createdBy": "string",
- "updatedBy": "string",
- "datasetId": "string",
- "rawDatasetId": "string",
- "derivedDatasetId": "string",
- "createdAt": "2019-08-24T14:15:22Z",
- "updatedAt": "2019-08-24T14:15:22Z"
}| id required | string <JSON> Dataset id |
| where | string <JSON> Criteria to match model instances |
{- "count": 0
}| id required | string <JSON> Dataset id |
| id required | string id currently needed by limitation in embedsmany |
{- "id": "string"
}{- "id": "string"
}| id required | string <JSON> Dataset id |
| filter | string <JSON> |
[- {
- "thumbnail": "retrieve",
- "caption": "",
- "ownerGroup": "string",
- "accessGroups": [
- "string"
], - "createdBy": "string",
- "updatedBy": "string",
- "id": "string",
- "datasetId": "string",
- "sampleId": "string",
- "proposalId": "string",
- "rawDatasetId": "string",
- "derivedDatasetId": "string",
- "createdAt": "2019-08-24T14:15:22Z",
- "updatedAt": "2019-08-24T14:15:22Z"
}
]| id required | string <JSON> Dataset id |
| thumbnail required | string Default: "retrieve" Contains a thumbnail preview in base64 encoded png format for a given dataset |
| caption | string Default: "" Attachment caption to show in catanie |
| ownerGroup required | string Defines the group which owns the data, and therefore has unrestricted access to this data. Usually a pgroup like p12151 |
| accessGroups | Array of strings Optional additional groups which have read access to the data. Users which are member in one of the groups listed here are allowed to access this data. The special group 'public' makes data available to all users |
| createdBy | string Functional or user account name who created this instance |
| updatedBy | string Functional or user account name who last updated this instance |
| id | string (ObjectID) ^[a-fA-F\d]{24}$ |
| datasetId | string |
| sampleId | string |
| proposalId | string |
| rawDatasetId | string |
| derivedDatasetId | string |
| createdAt | string <date-time> |
| updatedAt | string <date-time> |
{- "thumbnail": "retrieve",
- "caption": "",
- "ownerGroup": "string",
- "accessGroups": [
- "string"
], - "createdBy": "string",
- "updatedBy": "string",
- "id": "string",
- "datasetId": "string",
- "sampleId": "string",
- "proposalId": "string",
- "rawDatasetId": "string",
- "derivedDatasetId": "string",
- "createdAt": "2019-08-24T14:15:22Z",
- "updatedAt": "2019-08-24T14:15:22Z"
}{- "thumbnail": "retrieve",
- "caption": "",
- "ownerGroup": "string",
- "accessGroups": [
- "string"
], - "createdBy": "string",
- "updatedBy": "string",
- "id": "string",
- "datasetId": "string",
- "sampleId": "string",
- "proposalId": "string",
- "rawDatasetId": "string",
- "derivedDatasetId": "string",
- "createdAt": "2019-08-24T14:15:22Z",
- "updatedAt": "2019-08-24T14:15:22Z"
}| id required | string <JSON> Dataset id |
| pid required | string Persistent Identifier dervied from UUIDv4 |
| name required | string The name of the technique |
{- "pid": "string",
- "name": "string"
}{- "pid": "string",
- "name": "string"
}| id required | string <JSON> Dataset id |
| where | string <JSON> Criteria to match model instances |
{- "count": 0
}Model instance data
| pid required | string Persistent Identifier for datasets derived from UUIDv4 and prepended automatically by site specific PID prefix like 20.500.12345/ |
| owner required | string Owner of the data set, usually first name + lastname |
| ownerEmail | string Email of owner of the data set |
| orcidOfOwner | string ORCID of owner https://orcid.org if available |
| contactEmail required | string Email of contact person for this dataset |
| sourceFolder required | string Absolute file path on file server containing the files of this dataset, e.g. /some/path/to/sourcefolder. In case of a single file dataset, e.g. HDF5 data, it contains the path up to, but excluding the filename. Trailing slashes are removed. |
| sourceFolderHost | string DNS host name of file server hosting sourceFolder, optionally including protocol e.g. [protocol://]fileserver1.example.com |
| size | number <double> Total size of all source files contained in source folder on disk when unpacked |
| packedSize | number <double> Total size of all datablock package files created for this dataset |
| numberOfFiles | number <double> Total number of lines in filelisting of all OrigDatablocks for this dataset |
| numberOfFilesArchived | number <double> Total number of lines in filelisting of all Datablocks for this dataset |
| creationTime required | string <date-time> Time when dataset became fully available on disk, i.e. all containing files have been written. Format according to chapter 5.6 internet date/time format in RFC 3339. Local times without timezone/offset info are automatically transformed to UTC using the timezone of the API server. |
| type required | string Characterize type of dataset, either 'base' or 'raw' or 'derived'. Autofilled when choosing the proper inherited models |
| validationStatus | string Defines a level of trust, e.g. a measure of how much data was verified or used by other persons |
| keywords | Array of strings Array of tags associated with the meaning or contents of this dataset. Values should ideally come from defined vocabularies, taxonomies, ontologies or knowledge graphs |
| description | string Free text explanation of contents of dataset |
| datasetName | string A name for the dataset, given by the creator to carry some semantic meaning. Useful for display purposes e.g. instead of displaying the pid. Will be autofilled if missing using info from sourceFolder |
| classification | string ACIA information about AUthenticity,COnfidentiality,INtegrity and AVailability requirements of dataset. E.g. AV(ailabilty)=medium could trigger the creation of a two tape copies. Format 'AV=medium,CO=low' |
| license | string Name of license under which data can be used |
| version | string Version of API used in creation of dataset |
| isPublished | boolean Flag is true when data are made publically available |
| ownerGroup required | string Defines the group which owns the data, and therefore has unrestricted access to this data. Usually a pgroup like p12151 |
| accessGroups | Array of strings Optional additional groups which have read access to the data. Users which are member in one of the groups listed here are allowed to access this data. The special group 'public' makes data available to all users |
| createdBy | string Functional or user account name who created this instance |
| updatedBy | string Functional or user account name who last updated this instance |
| createdAt | string <date-time> |
| updatedAt | string <date-time> |
| publishedDataId | string |
| publisheddataId | string |
object (DatasetLifecycle) For each dataset there exists an embedded dataset lifecycle document which describes the current status of the dataset during its lifetime with respect to the storage handling systems | |
Array of objects (Message) | |
| instrumentId | string |
Array of objects (Technique) |
{- "pid": "string",
- "owner": "string",
- "ownerEmail": "string",
- "orcidOfOwner": "string",
- "contactEmail": "string",
- "sourceFolder": "string",
- "sourceFolderHost": "string",
- "size": 0,
- "packedSize": 0,
- "numberOfFiles": 0,
- "numberOfFilesArchived": 0,
- "creationTime": "2019-08-24T14:15:22Z",
- "type": "string",
- "validationStatus": "string",
- "keywords": [
- "string"
], - "description": "string",
- "datasetName": "string",
- "classification": "string",
- "license": "string",
- "version": "string",
- "isPublished": true,
- "ownerGroup": "string",
- "accessGroups": [
- "string"
], - "createdBy": "string",
- "updatedBy": "string",
- "createdAt": "2019-08-24T14:15:22Z",
- "updatedAt": "2019-08-24T14:15:22Z",
- "publishedDataId": "string",
- "publisheddataId": "string",
- "datasetlifecycle": {
- "archivable": true,
- "retrievable": true,
- "publishable": true,
- "dateOfDiskPurging": "2019-08-24T14:15:22Z",
- "archiveRetentionTime": "2019-08-24T14:15:22Z",
- "dateOfPublishing": "2019-08-24T14:15:22Z",
- "isOnCentralDisk": true,
- "archiveStatusMessage": "string",
- "retrieveStatusMessage": "string",
- "archiveReturnMessage": { },
- "retrieveReturnMessage": { },
- "exportedTo": "string",
- "retrieveIntegrityCheck": true,
- "id": "string"
}, - "history": [
- {
- "id": "string"
}
], - "instrumentId": "string",
- "techniques": [
- {
- "pid": "string",
- "name": "string"
}
]
}{- "pid": "string",
- "owner": "string",
- "ownerEmail": "string",
- "orcidOfOwner": "string",
- "contactEmail": "string",
- "sourceFolder": "string",
- "sourceFolderHost": "string",
- "size": 0,
- "packedSize": 0,
- "numberOfFiles": 0,
- "numberOfFilesArchived": 0,
- "creationTime": "2019-08-24T14:15:22Z",
- "type": "string",
- "validationStatus": "string",
- "keywords": [
- "string"
], - "description": "string",
- "datasetName": "string",
- "classification": "string",
- "license": "string",
- "version": "string",
- "isPublished": true,
- "ownerGroup": "string",
- "accessGroups": [
- "string"
], - "createdBy": "string",
- "updatedBy": "string",
- "createdAt": "2019-08-24T14:15:22Z",
- "updatedAt": "2019-08-24T14:15:22Z",
- "publishedDataId": "string",
- "publisheddataId": "string",
- "datasetlifecycle": {
- "archivable": true,
- "retrievable": true,
- "publishable": true,
- "dateOfDiskPurging": "2019-08-24T14:15:22Z",
- "archiveRetentionTime": "2019-08-24T14:15:22Z",
- "dateOfPublishing": "2019-08-24T14:15:22Z",
- "isOnCentralDisk": true,
- "archiveStatusMessage": "string",
- "retrieveStatusMessage": "string",
- "archiveReturnMessage": { },
- "retrieveReturnMessage": { },
- "exportedTo": "string",
- "retrieveIntegrityCheck": true,
- "id": "string"
}, - "history": [
- {
- "id": "string"
}
], - "instrumentId": "string",
- "techniques": [
- {
- "pid": "string",
- "name": "string"
}
]
}Model instance data
| pid required | string Persistent Identifier for datasets derived from UUIDv4 and prepended automatically by site specific PID prefix like 20.500.12345/ |
| owner required | string Owner of the data set, usually first name + lastname |
| ownerEmail | string Email of owner of the data set |
| orcidOfOwner | string ORCID of owner https://orcid.org if available |
| contactEmail required | string Email of contact person for this dataset |
| sourceFolder required | string Absolute file path on file server containing the files of this dataset, e.g. /some/path/to/sourcefolder. In case of a single file dataset, e.g. HDF5 data, it contains the path up to, but excluding the filename. Trailing slashes are removed. |
| sourceFolderHost | string DNS host name of file server hosting sourceFolder, optionally including protocol e.g. [protocol://]fileserver1.example.com |
| size | number <double> Total size of all source files contained in source folder on disk when unpacked |
| packedSize | number <double> Total size of all datablock package files created for this dataset |
| numberOfFiles | number <double> Total number of lines in filelisting of all OrigDatablocks for this dataset |
| numberOfFilesArchived | number <double> Total number of lines in filelisting of all Datablocks for this dataset |
| creationTime required | string <date-time> Time when dataset became fully available on disk, i.e. all containing files have been written. Format according to chapter 5.6 internet date/time format in RFC 3339. Local times without timezone/offset info are automatically transformed to UTC using the timezone of the API server. |
| type required | string Characterize type of dataset, either 'base' or 'raw' or 'derived'. Autofilled when choosing the proper inherited models |
| validationStatus | string Defines a level of trust, e.g. a measure of how much data was verified or used by other persons |
| keywords | Array of strings Array of tags associated with the meaning or contents of this dataset. Values should ideally come from defined vocabularies, taxonomies, ontologies or knowledge graphs |
| description | string Free text explanation of contents of dataset |
| datasetName | string A name for the dataset, given by the creator to carry some semantic meaning. Useful for display purposes e.g. instead of displaying the pid. Will be autofilled if missing using info from sourceFolder |
| classification | string ACIA information about AUthenticity,COnfidentiality,INtegrity and AVailability requirements of dataset. E.g. AV(ailabilty)=medium could trigger the creation of a two tape copies. Format 'AV=medium,CO=low' |
| license | string Name of license under which data can be used |
| version | string Version of API used in creation of dataset |
| isPublished | boolean Flag is true when data are made publically available |
| ownerGroup required | string Defines the group which owns the data, and therefore has unrestricted access to this data. Usually a pgroup like p12151 |
| accessGroups | Array of strings Optional additional groups which have read access to the data. Users which are member in one of the groups listed here are allowed to access this data. The special group 'public' makes data available to all users |
| createdBy | string Functional or user account name who created this instance |
| updatedBy | string Functional or user account name who last updated this instance |
| createdAt | string <date-time> |
| updatedAt | string <date-time> |
| publishedDataId | string |
| publisheddataId | string |
object (DatasetLifecycle) For each dataset there exists an embedded dataset lifecycle document which describes the current status of the dataset during its lifetime with respect to the storage handling systems | |
Array of objects (Message) | |
| instrumentId | string |
Array of objects (Technique) |
{- "pid": "string",
- "owner": "string",
- "ownerEmail": "string",
- "orcidOfOwner": "string",
- "contactEmail": "string",
- "sourceFolder": "string",
- "sourceFolderHost": "string",
- "size": 0,
- "packedSize": 0,
- "numberOfFiles": 0,
- "numberOfFilesArchived": 0,
- "creationTime": "2019-08-24T14:15:22Z",
- "type": "string",
- "validationStatus": "string",
- "keywords": [
- "string"
], - "description": "string",
- "datasetName": "string",
- "classification": "string",
- "license": "string",
- "version": "string",
- "isPublished": true,
- "ownerGroup": "string",
- "accessGroups": [
- "string"
], - "createdBy": "string",
- "updatedBy": "string",
- "createdAt": "2019-08-24T14:15:22Z",
- "updatedAt": "2019-08-24T14:15:22Z",
- "publishedDataId": "string",
- "publisheddataId": "string",
- "datasetlifecycle": {
- "archivable": true,
- "retrievable": true,
- "publishable": true,
- "dateOfDiskPurging": "2019-08-24T14:15:22Z",
- "archiveRetentionTime": "2019-08-24T14:15:22Z",
- "dateOfPublishing": "2019-08-24T14:15:22Z",
- "isOnCentralDisk": true,
- "archiveStatusMessage": "string",
- "retrieveStatusMessage": "string",
- "archiveReturnMessage": { },
- "retrieveReturnMessage": { },
- "exportedTo": "string",
- "retrieveIntegrityCheck": true,
- "id": "string"
}, - "history": [
- {
- "id": "string"
}
], - "instrumentId": "string",
- "techniques": [
- {
- "pid": "string",
- "name": "string"
}
]
}{- "pid": "string",
- "owner": "string",
- "ownerEmail": "string",
- "orcidOfOwner": "string",
- "contactEmail": "string",
- "sourceFolder": "string",
- "sourceFolderHost": "string",
- "size": 0,
- "packedSize": 0,
- "numberOfFiles": 0,
- "numberOfFilesArchived": 0,
- "creationTime": "2019-08-24T14:15:22Z",
- "type": "string",
- "validationStatus": "string",
- "keywords": [
- "string"
], - "description": "string",
- "datasetName": "string",
- "classification": "string",
- "license": "string",
- "version": "string",
- "isPublished": true,
- "ownerGroup": "string",
- "accessGroups": [
- "string"
], - "createdBy": "string",
- "updatedBy": "string",
- "createdAt": "2019-08-24T14:15:22Z",
- "updatedAt": "2019-08-24T14:15:22Z",
- "publishedDataId": "string",
- "publisheddataId": "string",
- "datasetlifecycle": {
- "archivable": true,
- "retrievable": true,
- "publishable": true,
- "dateOfDiskPurging": "2019-08-24T14:15:22Z",
- "archiveRetentionTime": "2019-08-24T14:15:22Z",
- "dateOfPublishing": "2019-08-24T14:15:22Z",
- "isOnCentralDisk": true,
- "archiveStatusMessage": "string",
- "retrieveStatusMessage": "string",
- "archiveReturnMessage": { },
- "retrieveReturnMessage": { },
- "exportedTo": "string",
- "retrieveIntegrityCheck": true,
- "id": "string"
}, - "history": [
- {
- "id": "string"
}
], - "instrumentId": "string",
- "techniques": [
- {
- "pid": "string",
- "name": "string"
}
]
}Model instance data
| pid required | string Persistent Identifier for datasets derived from UUIDv4 and prepended automatically by site specific PID prefix like 20.500.12345/ |
| owner required | string Owner of the data set, usually first name + lastname |
| ownerEmail | string Email of owner of the data set |
| orcidOfOwner | string ORCID of owner https://orcid.org if available |
| contactEmail required | string Email of contact person for this dataset |
| sourceFolder required | string Absolute file path on file server containing the files of this dataset, e.g. /some/path/to/sourcefolder. In case of a single file dataset, e.g. HDF5 data, it contains the path up to, but excluding the filename. Trailing slashes are removed. |
| sourceFolderHost | string DNS host name of file server hosting sourceFolder, optionally including protocol e.g. [protocol://]fileserver1.example.com |
| size | number <double> Total size of all source files contained in source folder on disk when unpacked |
| packedSize | number <double> Total size of all datablock package files created for this dataset |
| numberOfFiles | number <double> Total number of lines in filelisting of all OrigDatablocks for this dataset |
| numberOfFilesArchived | number <double> Total number of lines in filelisting of all Datablocks for this dataset |
| creationTime required | string <date-time> Time when dataset became fully available on disk, i.e. all containing files have been written. Format according to chapter 5.6 internet date/time format in RFC 3339. Local times without timezone/offset info are automatically transformed to UTC using the timezone of the API server. |
| type required | string Characterize type of dataset, either 'base' or 'raw' or 'derived'. Autofilled when choosing the proper inherited models |
| validationStatus | string Defines a level of trust, e.g. a measure of how much data was verified or used by other persons |
| keywords | Array of strings Array of tags associated with the meaning or contents of this dataset. Values should ideally come from defined vocabularies, taxonomies, ontologies or knowledge graphs |
| description | string Free text explanation of contents of dataset |
| datasetName | string A name for the dataset, given by the creator to carry some semantic meaning. Useful for display purposes e.g. instead of displaying the pid. Will be autofilled if missing using info from sourceFolder |
| classification | string ACIA information about AUthenticity,COnfidentiality,INtegrity and AVailability requirements of dataset. E.g. AV(ailabilty)=medium could trigger the creation of a two tape copies. Format 'AV=medium,CO=low' |
| license | string Name of license under which data can be used |
| version | string Version of API used in creation of dataset |
| isPublished | boolean Flag is true when data are made publically available |
| ownerGroup required | string Defines the group which owns the data, and therefore has unrestricted access to this data. Usually a pgroup like p12151 |
| accessGroups | Array of strings Optional additional groups which have read access to the data. Users which are member in one of the groups listed here are allowed to access this data. The special group 'public' makes data available to all users |
| createdBy | string Functional or user account name who created this instance |
| updatedBy | string Functional or user account name who last updated this instance |
| createdAt | string <date-time> |
| updatedAt | string <date-time> |
| publishedDataId | string |
| publisheddataId | string |
object (DatasetLifecycle) For each dataset there exists an embedded dataset lifecycle document which describes the current status of the dataset during its lifetime with respect to the storage handling systems | |
Array of objects (Message) | |
| instrumentId | string |
Array of objects (Technique) |
{- "pid": "string",
- "owner": "string",
- "ownerEmail": "string",
- "orcidOfOwner": "string",
- "contactEmail": "string",
- "sourceFolder": "string",
- "sourceFolderHost": "string",
- "size": 0,
- "packedSize": 0,
- "numberOfFiles": 0,
- "numberOfFilesArchived": 0,
- "creationTime": "2019-08-24T14:15:22Z",
- "type": "string",
- "validationStatus": "string",
- "keywords": [
- "string"
], - "description": "string",
- "datasetName": "string",
- "classification": "string",
- "license": "string",
- "version": "string",
- "isPublished": true,
- "ownerGroup": "string",
- "accessGroups": [
- "string"
], - "createdBy": "string",
- "updatedBy": "string",
- "createdAt": "2019-08-24T14:15:22Z",
- "updatedAt": "2019-08-24T14:15:22Z",
- "publishedDataId": "string",
- "publisheddataId": "string",
- "datasetlifecycle": {
- "archivable": true,
- "retrievable": true,
- "publishable": true,
- "dateOfDiskPurging": "2019-08-24T14:15:22Z",
- "archiveRetentionTime": "2019-08-24T14:15:22Z",
- "dateOfPublishing": "2019-08-24T14:15:22Z",
- "isOnCentralDisk": true,
- "archiveStatusMessage": "string",
- "retrieveStatusMessage": "string",
- "archiveReturnMessage": { },
- "retrieveReturnMessage": { },
- "exportedTo": "string",
- "retrieveIntegrityCheck": true,
- "id": "string"
}, - "history": [
- {
- "id": "string"
}
], - "instrumentId": "string",
- "techniques": [
- {
- "pid": "string",
- "name": "string"
}
]
}{- "pid": "string",
- "owner": "string",
- "ownerEmail": "string",
- "orcidOfOwner": "string",
- "contactEmail": "string",
- "sourceFolder": "string",
- "sourceFolderHost": "string",
- "size": 0,
- "packedSize": 0,
- "numberOfFiles": 0,
- "numberOfFilesArchived": 0,
- "creationTime": "2019-08-24T14:15:22Z",
- "type": "string",
- "validationStatus": "string",
- "keywords": [
- "string"
], - "description": "string",
- "datasetName": "string",
- "classification": "string",
- "license": "string",
- "version": "string",
- "isPublished": true,
- "ownerGroup": "string",
- "accessGroups": [
- "string"
], - "createdBy": "string",
- "updatedBy": "string",
- "createdAt": "2019-08-24T14:15:22Z",
- "updatedAt": "2019-08-24T14:15:22Z",
- "publishedDataId": "string",
- "publisheddataId": "string",
- "datasetlifecycle": {
- "archivable": true,
- "retrievable": true,
- "publishable": true,
- "dateOfDiskPurging": "2019-08-24T14:15:22Z",
- "archiveRetentionTime": "2019-08-24T14:15:22Z",
- "dateOfPublishing": "2019-08-24T14:15:22Z",
- "isOnCentralDisk": true,
- "archiveStatusMessage": "string",
- "retrieveStatusMessage": "string",
- "archiveReturnMessage": { },
- "retrieveReturnMessage": { },
- "exportedTo": "string",
- "retrieveIntegrityCheck": true,
- "id": "string"
}, - "history": [
- {
- "id": "string"
}
], - "instrumentId": "string",
- "techniques": [
- {
- "pid": "string",
- "name": "string"
}
]
}| filter | string <JSON> Filter defining fields, where, include, order, offset, and limit - must be a JSON-encoded string ( |
[- {
- "pid": "string",
- "owner": "string",
- "ownerEmail": "string",
- "orcidOfOwner": "string",
- "contactEmail": "string",
- "sourceFolder": "string",
- "sourceFolderHost": "string",
- "size": 0,
- "packedSize": 0,
- "numberOfFiles": 0,
- "numberOfFilesArchived": 0,
- "creationTime": "2019-08-24T14:15:22Z",
- "type": "string",
- "validationStatus": "string",
- "keywords": [
- "string"
], - "description": "string",
- "datasetName": "string",
- "classification": "string",
- "license": "string",
- "version": "string",
- "isPublished": true,
- "ownerGroup": "string",
- "accessGroups": [
- "string"
], - "createdBy": "string",
- "updatedBy": "string",
- "createdAt": "2019-08-24T14:15:22Z",
- "updatedAt": "2019-08-24T14:15:22Z",
- "publishedDataId": "string",
- "publisheddataId": "string",
- "datasetlifecycle": {
- "archivable": true,
- "retrievable": true,
- "publishable": true,
- "dateOfDiskPurging": "2019-08-24T14:15:22Z",
- "archiveRetentionTime": "2019-08-24T14:15:22Z",
- "dateOfPublishing": "2019-08-24T14:15:22Z",
- "isOnCentralDisk": true,
- "archiveStatusMessage": "string",
- "retrieveStatusMessage": "string",
- "archiveReturnMessage": { },
- "retrieveReturnMessage": { },
- "exportedTo": "string",
- "retrieveIntegrityCheck": true,
- "id": "string"
}, - "history": [
- {
- "id": "string"
}
], - "instrumentId": "string",
- "techniques": [
- {
- "pid": "string",
- "name": "string"
}
]
}
]Model instance data
| pid required | string Persistent Identifier for datasets derived from UUIDv4 and prepended automatically by site specific PID prefix like 20.500.12345/ |
| owner required | string Owner of the data set, usually first name + lastname |
| ownerEmail | string Email of owner of the data set |
| orcidOfOwner | string ORCID of owner https://orcid.org if available |
| contactEmail required | string Email of contact person for this dataset |
| sourceFolder required | string Absolute file path on file server containing the files of this dataset, e.g. /some/path/to/sourcefolder. In case of a single file dataset, e.g. HDF5 data, it contains the path up to, but excluding the filename. Trailing slashes are removed. |
| sourceFolderHost | string DNS host name of file server hosting sourceFolder, optionally including protocol e.g. [protocol://]fileserver1.example.com |
| size | number <double> Total size of all source files contained in source folder on disk when unpacked |
| packedSize | number <double> Total size of all datablock package files created for this dataset |
| numberOfFiles | number <double> Total number of lines in filelisting of all OrigDatablocks for this dataset |
| numberOfFilesArchived | number <double> Total number of lines in filelisting of all Datablocks for this dataset |
| creationTime required | string <date-time> Time when dataset became fully available on disk, i.e. all containing files have been written. Format according to chapter 5.6 internet date/time format in RFC 3339. Local times without timezone/offset info are automatically transformed to UTC using the timezone of the API server. |
| type required | string Characterize type of dataset, either 'base' or 'raw' or 'derived'. Autofilled when choosing the proper inherited models |
| validationStatus | string Defines a level of trust, e.g. a measure of how much data was verified or used by other persons |
| keywords | Array of strings Array of tags associated with the meaning or contents of this dataset. Values should ideally come from defined vocabularies, taxonomies, ontologies or knowledge graphs |
| description | string Free text explanation of contents of dataset |
| datasetName | string A name for the dataset, given by the creator to carry some semantic meaning. Useful for display purposes e.g. instead of displaying the pid. Will be autofilled if missing using info from sourceFolder |
| classification | string ACIA information about AUthenticity,COnfidentiality,INtegrity and AVailability requirements of dataset. E.g. AV(ailabilty)=medium could trigger the creation of a two tape copies. Format 'AV=medium,CO=low' |
| license | string Name of license under which data can be used |
| version | string Version of API used in creation of dataset |
| isPublished | boolean Flag is true when data are made publically available |
| ownerGroup required | string Defines the group which owns the data, and therefore has unrestricted access to this data. Usually a pgroup like p12151 |
| accessGroups | Array of strings Optional additional groups which have read access to the data. Users which are member in one of the groups listed here are allowed to access this data. The special group 'public' makes data available to all users |
| createdBy | string Functional or user account name who created this instance |
| updatedBy | string Functional or user account name who last updated this instance |
| createdAt | string <date-time> |
| updatedAt | string <date-time> |
| publishedDataId | string |
| publisheddataId | string |
object (DatasetLifecycle) For each dataset there exists an embedded dataset lifecycle document which describes the current status of the dataset during its lifetime with respect to the storage handling systems | |
Array of objects (Message) | |
| instrumentId | string |
Array of objects (Technique) |
{- "pid": "string",
- "owner": "string",
- "ownerEmail": "string",
- "orcidOfOwner": "string",
- "contactEmail": "string",
- "sourceFolder": "string",
- "sourceFolderHost": "string",
- "size": 0,
- "packedSize": 0,
- "numberOfFiles": 0,
- "numberOfFilesArchived": 0,
- "creationTime": "2019-08-24T14:15:22Z",
- "type": "string",
- "validationStatus": "string",
- "keywords": [
- "string"
], - "description": "string",
- "datasetName": "string",
- "classification": "string",
- "license": "string",
- "version": "string",
- "isPublished": true,
- "ownerGroup": "string",
- "accessGroups": [
- "string"
], - "createdBy": "string",
- "updatedBy": "string",
- "createdAt": "2019-08-24T14:15:22Z",
- "updatedAt": "2019-08-24T14:15:22Z",
- "publishedDataId": "string",
- "publisheddataId": "string",
- "datasetlifecycle": {
- "archivable": true,
- "retrievable": true,
- "publishable": true,
- "dateOfDiskPurging": "2019-08-24T14:15:22Z",
- "archiveRetentionTime": "2019-08-24T14:15:22Z",
- "dateOfPublishing": "2019-08-24T14:15:22Z",
- "isOnCentralDisk": true,
- "archiveStatusMessage": "string",
- "retrieveStatusMessage": "string",
- "archiveReturnMessage": { },
- "retrieveReturnMessage": { },
- "exportedTo": "string",
- "retrieveIntegrityCheck": true,
- "id": "string"
}, - "history": [
- {
- "id": "string"
}
], - "instrumentId": "string",
- "techniques": [
- {
- "pid": "string",
- "name": "string"
}
]
}{- "pid": "string",
- "owner": "string",
- "ownerEmail": "string",
- "orcidOfOwner": "string",
- "contactEmail": "string",
- "sourceFolder": "string",
- "sourceFolderHost": "string",
- "size": 0,
- "packedSize": 0,
- "numberOfFiles": 0,
- "numberOfFilesArchived": 0,
- "creationTime": "2019-08-24T14:15:22Z",
- "type": "string",
- "validationStatus": "string",
- "keywords": [
- "string"
], - "description": "string",
- "datasetName": "string",
- "classification": "string",
- "license": "string",
- "version": "string",
- "isPublished": true,
- "ownerGroup": "string",
- "accessGroups": [
- "string"
], - "createdBy": "string",
- "updatedBy": "string",
- "createdAt": "2019-08-24T14:15:22Z",
- "updatedAt": "2019-08-24T14:15:22Z",
- "publishedDataId": "string",
- "publisheddataId": "string",
- "datasetlifecycle": {
- "archivable": true,
- "retrievable": true,
- "publishable": true,
- "dateOfDiskPurging": "2019-08-24T14:15:22Z",
- "archiveRetentionTime": "2019-08-24T14:15:22Z",
- "dateOfPublishing": "2019-08-24T14:15:22Z",
- "isOnCentralDisk": true,
- "archiveStatusMessage": "string",
- "retrieveStatusMessage": "string",
- "archiveReturnMessage": { },
- "retrieveReturnMessage": { },
- "exportedTo": "string",
- "retrieveIntegrityCheck": true,
- "id": "string"
}, - "history": [
- {
- "id": "string"
}
], - "instrumentId": "string",
- "techniques": [
- {
- "pid": "string",
- "name": "string"
}
]
}| where | string <JSON> Criteria to match model instances |
An object of model property name/value pairs
| pid required | string Persistent Identifier for datasets derived from UUIDv4 and prepended automatically by site specific PID prefix like 20.500.12345/ |
| owner required | string Owner of the data set, usually first name + lastname |
| ownerEmail | string Email of owner of the data set |
| orcidOfOwner | string ORCID of owner https://orcid.org if available |
| contactEmail required | string Email of contact person for this dataset |
| sourceFolder required | string Absolute file path on file server containing the files of this dataset, e.g. /some/path/to/sourcefolder. In case of a single file dataset, e.g. HDF5 data, it contains the path up to, but excluding the filename. Trailing slashes are removed. |
| sourceFolderHost | string DNS host name of file server hosting sourceFolder, optionally including protocol e.g. [protocol://]fileserver1.example.com |
| size | number <double> Total size of all source files contained in source folder on disk when unpacked |
| packedSize | number <double> Total size of all datablock package files created for this dataset |
| numberOfFiles | number <double> Total number of lines in filelisting of all OrigDatablocks for this dataset |
| numberOfFilesArchived | number <double> Total number of lines in filelisting of all Datablocks for this dataset |
| creationTime required | string <date-time> Time when dataset became fully available on disk, i.e. all containing files have been written. Format according to chapter 5.6 internet date/time format in RFC 3339. Local times without timezone/offset info are automatically transformed to UTC using the timezone of the API server. |
| type required | string Characterize type of dataset, either 'base' or 'raw' or 'derived'. Autofilled when choosing the proper inherited models |
| validationStatus | string Defines a level of trust, e.g. a measure of how much data was verified or used by other persons |
| keywords | Array of strings Array of tags associated with the meaning or contents of this dataset. Values should ideally come from defined vocabularies, taxonomies, ontologies or knowledge graphs |
| description | string Free text explanation of contents of dataset |
| datasetName | string A name for the dataset, given by the creator to carry some semantic meaning. Useful for display purposes e.g. instead of displaying the pid. Will be autofilled if missing using info from sourceFolder |
| classification | string ACIA information about AUthenticity,COnfidentiality,INtegrity and AVailability requirements of dataset. E.g. AV(ailabilty)=medium could trigger the creation of a two tape copies. Format 'AV=medium,CO=low' |
| license | string Name of license under which data can be used |
| version | string Version of API used in creation of dataset |
| isPublished | boolean Flag is true when data are made publically available |
| ownerGroup required | string Defines the group which owns the data, and therefore has unrestricted access to this data. Usually a pgroup like p12151 |
| accessGroups | Array of strings Optional additional groups which have read access to the data. Users which are member in one of the groups listed here are allowed to access this data. The special group 'public' makes data available to all users |
| createdBy | string Functional or user account name who created this instance |
| updatedBy | string Functional or user account name who last updated this instance |
| createdAt | string <date-time> |
| updatedAt | string <date-time> |
| publishedDataId | string |
| publisheddataId | string |
object (DatasetLifecycle) For each dataset there exists an embedded dataset lifecycle document which describes the current status of the dataset during its lifetime with respect to the storage handling systems | |
Array of objects (Message) | |
| instrumentId | string |
Array of objects (Technique) |
{- "pid": "string",
- "owner": "string",
- "ownerEmail": "string",
- "orcidOfOwner": "string",
- "contactEmail": "string",
- "sourceFolder": "string",
- "sourceFolderHost": "string",
- "size": 0,
- "packedSize": 0,
- "numberOfFiles": 0,
- "numberOfFilesArchived": 0,
- "creationTime": "2019-08-24T14:15:22Z",
- "type": "string",
- "validationStatus": "string",
- "keywords": [
- "string"
], - "description": "string",
- "datasetName": "string",
- "classification": "string",
- "license": "string",
- "version": "string",
- "isPublished": true,
- "ownerGroup": "string",
- "accessGroups": [
- "string"
], - "createdBy": "string",
- "updatedBy": "string",
- "createdAt": "2019-08-24T14:15:22Z",
- "updatedAt": "2019-08-24T14:15:22Z",
- "publishedDataId": "string",
- "publisheddataId": "string",
- "datasetlifecycle": {
- "archivable": true,
- "retrievable": true,
- "publishable": true,
- "dateOfDiskPurging": "2019-08-24T14:15:22Z",
- "archiveRetentionTime": "2019-08-24T14:15:22Z",
- "dateOfPublishing": "2019-08-24T14:15:22Z",
- "isOnCentralDisk": true,
- "archiveStatusMessage": "string",
- "retrieveStatusMessage": "string",
- "archiveReturnMessage": { },
- "retrieveReturnMessage": { },
- "exportedTo": "string",
- "retrieveIntegrityCheck": true,
- "id": "string"
}, - "history": [
- {
- "id": "string"
}
], - "instrumentId": "string",
- "techniques": [
- {
- "pid": "string",
- "name": "string"
}
]
}{- "pid": "string",
- "owner": "string",
- "ownerEmail": "string",
- "orcidOfOwner": "string",
- "contactEmail": "string",
- "sourceFolder": "string",
- "sourceFolderHost": "string",
- "size": 0,
- "packedSize": 0,
- "numberOfFiles": 0,
- "numberOfFilesArchived": 0,
- "creationTime": "2019-08-24T14:15:22Z",
- "type": "string",
- "validationStatus": "string",
- "keywords": [
- "string"
], - "description": "string",
- "datasetName": "string",
- "classification": "string",
- "license": "string",
- "version": "string",
- "isPublished": true,
- "ownerGroup": "string",
- "accessGroups": [
- "string"
], - "createdBy": "string",
- "updatedBy": "string",
- "createdAt": "2019-08-24T14:15:22Z",
- "updatedAt": "2019-08-24T14:15:22Z",
- "publishedDataId": "string",
- "publisheddataId": "string",
- "datasetlifecycle": {
- "archivable": true,
- "retrievable": true,
- "publishable": true,
- "dateOfDiskPurging": "2019-08-24T14:15:22Z",
- "archiveRetentionTime": "2019-08-24T14:15:22Z",
- "dateOfPublishing": "2019-08-24T14:15:22Z",
- "isOnCentralDisk": true,
- "archiveStatusMessage": "string",
- "retrieveStatusMessage": "string",
- "archiveReturnMessage": { },
- "retrieveReturnMessage": { },
- "exportedTo": "string",
- "retrieveIntegrityCheck": true,
- "id": "string"
}, - "history": [
- {
- "id": "string"
}
], - "instrumentId": "string",
- "techniques": [
- {
- "pid": "string",
- "name": "string"
}
]
}| id required | string <JSON> Model id |
| filter | string <JSON> Filter defining fields and include - must be a JSON-encoded string ({"something":"value"}) |
{- "pid": "string",
- "owner": "string",
- "ownerEmail": "string",
- "orcidOfOwner": "string",
- "contactEmail": "string",
- "sourceFolder": "string",
- "sourceFolderHost": "string",
- "size": 0,
- "packedSize": 0,
- "numberOfFiles": 0,
- "numberOfFilesArchived": 0,
- "creationTime": "2019-08-24T14:15:22Z",
- "type": "string",
- "validationStatus": "string",
- "keywords": [
- "string"
], - "description": "string",
- "datasetName": "string",
- "classification": "string",
- "license": "string",
- "version": "string",
- "isPublished": true,
- "ownerGroup": "string",
- "accessGroups": [
- "string"
], - "createdBy": "string",
- "updatedBy": "string",
- "createdAt": "2019-08-24T14:15:22Z",
- "updatedAt": "2019-08-24T14:15:22Z",
- "publishedDataId": "string",
- "publisheddataId": "string",
- "datasetlifecycle": {
- "archivable": true,
- "retrievable": true,
- "publishable": true,
- "dateOfDiskPurging": "2019-08-24T14:15:22Z",
- "archiveRetentionTime": "2019-08-24T14:15:22Z",
- "dateOfPublishing": "2019-08-24T14:15:22Z",
- "isOnCentralDisk": true,
- "archiveStatusMessage": "string",
- "retrieveStatusMessage": "string",
- "archiveReturnMessage": { },
- "retrieveReturnMessage": { },
- "exportedTo": "string",
- "retrieveIntegrityCheck": true,
- "id": "string"
}, - "history": [
- {
- "id": "string"
}
], - "instrumentId": "string",
- "techniques": [
- {
- "pid": "string",
- "name": "string"
}
]
}| id required | string <JSON> Dataset id |
An object of model property name/value pairs
| pid required | string Persistent Identifier for datasets derived from UUIDv4 and prepended automatically by site specific PID prefix like 20.500.12345/ |
| owner required | string Owner of the data set, usually first name + lastname |
| ownerEmail | string Email of owner of the data set |
| orcidOfOwner | string ORCID of owner https://orcid.org if available |
| contactEmail required | string Email of contact person for this dataset |
| sourceFolder required | string Absolute file path on file server containing the files of this dataset, e.g. /some/path/to/sourcefolder. In case of a single file dataset, e.g. HDF5 data, it contains the path up to, but excluding the filename. Trailing slashes are removed. |
| sourceFolderHost | string DNS host name of file server hosting sourceFolder, optionally including protocol e.g. [protocol://]fileserver1.example.com |
| size | number <double> Total size of all source files contained in source folder on disk when unpacked |
| packedSize | number <double> Total size of all datablock package files created for this dataset |
| numberOfFiles | number <double> Total number of lines in filelisting of all OrigDatablocks for this dataset |
| numberOfFilesArchived | number <double> Total number of lines in filelisting of all Datablocks for this dataset |
| creationTime required | string <date-time> Time when dataset became fully available on disk, i.e. all containing files have been written. Format according to chapter 5.6 internet date/time format in RFC 3339. Local times without timezone/offset info are automatically transformed to UTC using the timezone of the API server. |
| type required | string Characterize type of dataset, either 'base' or 'raw' or 'derived'. Autofilled when choosing the proper inherited models |
| validationStatus | string Defines a level of trust, e.g. a measure of how much data was verified or used by other persons |
| keywords | Array of strings Array of tags associated with the meaning or contents of this dataset. Values should ideally come from defined vocabularies, taxonomies, ontologies or knowledge graphs |
| description | string Free text explanation of contents of dataset |
| datasetName | string A name for the dataset, given by the creator to carry some semantic meaning. Useful for display purposes e.g. instead of displaying the pid. Will be autofilled if missing using info from sourceFolder |
| classification | string ACIA information about AUthenticity,COnfidentiality,INtegrity and AVailability requirements of dataset. E.g. AV(ailabilty)=medium could trigger the creation of a two tape copies. Format 'AV=medium,CO=low' |
| license | string Name of license under which data can be used |
| version | string Version of API used in creation of dataset |
| isPublished | boolean Flag is true when data are made publically available |
| ownerGroup required | string Defines the group which owns the data, and therefore has unrestricted access to this data. Usually a pgroup like p12151 |
| accessGroups | Array of strings Optional additional groups which have read access to the data. Users which are member in one of the groups listed here are allowed to access this data. The special group 'public' makes data available to all users |
| createdBy | string Functional or user account name who created this instance |
| updatedBy | string Functional or user account name who last updated this instance |
| createdAt | string <date-time> |
| updatedAt | string <date-time> |
| publishedDataId | string |
| publisheddataId | string |
object (DatasetLifecycle) For each dataset there exists an embedded dataset lifecycle document which describes the current status of the dataset during its lifetime with respect to the storage handling systems | |
Array of objects (Message) | |
| instrumentId | string |
Array of objects (Technique) |
{- "pid": "string",
- "owner": "string",
- "ownerEmail": "string",
- "orcidOfOwner": "string",
- "contactEmail": "string",
- "sourceFolder": "string",
- "sourceFolderHost": "string",
- "size": 0,
- "packedSize": 0,
- "numberOfFiles": 0,
- "numberOfFilesArchived": 0,
- "creationTime": "2019-08-24T14:15:22Z",
- "type": "string",
- "validationStatus": "string",
- "keywords": [
- "string"
], - "description": "string",
- "datasetName": "string",
- "classification": "string",
- "license": "string",
- "version": "string",
- "isPublished": true,
- "ownerGroup": "string",
- "accessGroups": [
- "string"
], - "createdBy": "string",
- "updatedBy": "string",
- "createdAt": "2019-08-24T14:15:22Z",
- "updatedAt": "2019-08-24T14:15:22Z",
- "publishedDataId": "string",
- "publisheddataId": "string",
- "datasetlifecycle": {
- "archivable": true,
- "retrievable": true,
- "publishable": true,
- "dateOfDiskPurging": "2019-08-24T14:15:22Z",
- "archiveRetentionTime": "2019-08-24T14:15:22Z",
- "dateOfPublishing": "2019-08-24T14:15:22Z",
- "isOnCentralDisk": true,
- "archiveStatusMessage": "string",
- "retrieveStatusMessage": "string",
- "archiveReturnMessage": { },
- "retrieveReturnMessage": { },
- "exportedTo": "string",
- "retrieveIntegrityCheck": true,
- "id": "string"
}, - "history": [
- {
- "id": "string"
}
], - "instrumentId": "string",
- "techniques": [
- {
- "pid": "string",
- "name": "string"
}
]
}{- "pid": "string",
- "owner": "string",
- "ownerEmail": "string",
- "orcidOfOwner": "string",
- "contactEmail": "string",
- "sourceFolder": "string",
- "sourceFolderHost": "string",
- "size": 0,
- "packedSize": 0,
- "numberOfFiles": 0,
- "numberOfFilesArchived": 0,
- "creationTime": "2019-08-24T14:15:22Z",
- "type": "string",
- "validationStatus": "string",
- "keywords": [
- "string"
], - "description": "string",
- "datasetName": "string",
- "classification": "string",
- "license": "string",
- "version": "string",
- "isPublished": true,
- "ownerGroup": "string",
- "accessGroups": [
- "string"
], - "createdBy": "string",
- "updatedBy": "string",
- "createdAt": "2019-08-24T14:15:22Z",
- "updatedAt": "2019-08-24T14:15:22Z",
- "publishedDataId": "string",
- "publisheddataId": "string",
- "datasetlifecycle": {
- "archivable": true,
- "retrievable": true,
- "publishable": true,
- "dateOfDiskPurging": "2019-08-24T14:15:22Z",
- "archiveRetentionTime": "2019-08-24T14:15:22Z",
- "dateOfPublishing": "2019-08-24T14:15:22Z",
- "isOnCentralDisk": true,
- "archiveStatusMessage": "string",
- "retrieveStatusMessage": "string",
- "archiveReturnMessage": { },
- "retrieveReturnMessage": { },
- "exportedTo": "string",
- "retrieveIntegrityCheck": true,
- "id": "string"
}, - "history": [
- {
- "id": "string"
}
], - "instrumentId": "string",
- "techniques": [
- {
- "pid": "string",
- "name": "string"
}
]
}| id required | string <JSON> Dataset id |
An object of model property name/value pairs
| pid required | string Persistent Identifier for datasets derived from UUIDv4 and prepended automatically by site specific PID prefix like 20.500.12345/ |
| owner required | string Owner of the data set, usually first name + lastname |
| ownerEmail | string Email of owner of the data set |
| orcidOfOwner | string ORCID of owner https://orcid.org if available |
| contactEmail required | string Email of contact person for this dataset |
| sourceFolder required | string Absolute file path on file server containing the files of this dataset, e.g. /some/path/to/sourcefolder. In case of a single file dataset, e.g. HDF5 data, it contains the path up to, but excluding the filename. Trailing slashes are removed. |
| sourceFolderHost | string DNS host name of file server hosting sourceFolder, optionally including protocol e.g. [protocol://]fileserver1.example.com |
| size | number <double> Total size of all source files contained in source folder on disk when unpacked |
| packedSize | number <double> Total size of all datablock package files created for this dataset |
| numberOfFiles | number <double> Total number of lines in filelisting of all OrigDatablocks for this dataset |
| numberOfFilesArchived | number <double> Total number of lines in filelisting of all Datablocks for this dataset |
| creationTime required | string <date-time> Time when dataset became fully available on disk, i.e. all containing files have been written. Format according to chapter 5.6 internet date/time format in RFC 3339. Local times without timezone/offset info are automatically transformed to UTC using the timezone of the API server. |
| type required | string Characterize type of dataset, either 'base' or 'raw' or 'derived'. Autofilled when choosing the proper inherited models |
| validationStatus | string Defines a level of trust, e.g. a measure of how much data was verified or used by other persons |
| keywords | Array of strings Array of tags associated with the meaning or contents of this dataset. Values should ideally come from defined vocabularies, taxonomies, ontologies or knowledge graphs |
| description | string Free text explanation of contents of dataset |
| datasetName | string A name for the dataset, given by the creator to carry some semantic meaning. Useful for display purposes e.g. instead of displaying the pid. Will be autofilled if missing using info from sourceFolder |
| classification | string ACIA information about AUthenticity,COnfidentiality,INtegrity and AVailability requirements of dataset. E.g. AV(ailabilty)=medium could trigger the creation of a two tape copies. Format 'AV=medium,CO=low' |
| license | string Name of license under which data can be used |
| version | string Version of API used in creation of dataset |
| isPublished | boolean Flag is true when data are made publically available |
| ownerGroup required | string Defines the group which owns the data, and therefore has unrestricted access to this data. Usually a pgroup like p12151 |
| accessGroups | Array of strings Optional additional groups which have read access to the data. Users which are member in one of the groups listed here are allowed to access this data. The special group 'public' makes data available to all users |
| createdBy | string Functional or user account name who created this instance |
| updatedBy | string Functional or user account name who last updated this instance |
| createdAt | string <date-time> |
| updatedAt | string <date-time> |
| publishedDataId | string |
| publisheddataId | string |
object (DatasetLifecycle) For each dataset there exists an embedded dataset lifecycle document which describes the current status of the dataset during its lifetime with respect to the storage handling systems | |
Array of objects (Message) | |
| instrumentId | string |
Array of objects (Technique) |
{- "pid": "string",
- "owner": "string",
- "ownerEmail": "string",
- "orcidOfOwner": "string",
- "contactEmail": "string",
- "sourceFolder": "string",
- "sourceFolderHost": "string",
- "size": 0,
- "packedSize": 0,
- "numberOfFiles": 0,
- "numberOfFilesArchived": 0,
- "creationTime": "2019-08-24T14:15:22Z",
- "type": "string",
- "validationStatus": "string",
- "keywords": [
- "string"
], - "description": "string",
- "datasetName": "string",
- "classification": "string",
- "license": "string",
- "version": "string",
- "isPublished": true,
- "ownerGroup": "string",
- "accessGroups": [
- "string"
], - "createdBy": "string",
- "updatedBy": "string",
- "createdAt": "2019-08-24T14:15:22Z",
- "updatedAt": "2019-08-24T14:15:22Z",
- "publishedDataId": "string",
- "publisheddataId": "string",
- "datasetlifecycle": {
- "archivable": true,
- "retrievable": true,
- "publishable": true,
- "dateOfDiskPurging": "2019-08-24T14:15:22Z",
- "archiveRetentionTime": "2019-08-24T14:15:22Z",
- "dateOfPublishing": "2019-08-24T14:15:22Z",
- "isOnCentralDisk": true,
- "archiveStatusMessage": "string",
- "retrieveStatusMessage": "string",
- "archiveReturnMessage": { },
- "retrieveReturnMessage": { },
- "exportedTo": "string",
- "retrieveIntegrityCheck": true,
- "id": "string"
}, - "history": [
- {
- "id": "string"
}
], - "instrumentId": "string",
- "techniques": [
- {
- "pid": "string",
- "name": "string"
}
]
}{- "pid": "string",
- "owner": "string",
- "ownerEmail": "string",
- "orcidOfOwner": "string",
- "contactEmail": "string",
- "sourceFolder": "string",
- "sourceFolderHost": "string",
- "size": 0,
- "packedSize": 0,
- "numberOfFiles": 0,
- "numberOfFilesArchived": 0,
- "creationTime": "2019-08-24T14:15:22Z",
- "type": "string",
- "validationStatus": "string",
- "keywords": [
- "string"
], - "description": "string",
- "datasetName": "string",
- "classification": "string",
- "license": "string",
- "version": "string",
- "isPublished": true,
- "ownerGroup": "string",
- "accessGroups": [
- "string"
], - "createdBy": "string",
- "updatedBy": "string",
- "createdAt": "2019-08-24T14:15:22Z",
- "updatedAt": "2019-08-24T14:15:22Z",
- "publishedDataId": "string",
- "publisheddataId": "string",
- "datasetlifecycle": {
- "archivable": true,
- "retrievable": true,
- "publishable": true,
- "dateOfDiskPurging": "2019-08-24T14:15:22Z",
- "archiveRetentionTime": "2019-08-24T14:15:22Z",
- "dateOfPublishing": "2019-08-24T14:15:22Z",
- "isOnCentralDisk": true,
- "archiveStatusMessage": "string",
- "retrieveStatusMessage": "string",
- "archiveReturnMessage": { },
- "retrieveReturnMessage": { },
- "exportedTo": "string",
- "retrieveIntegrityCheck": true,
- "id": "string"
}, - "history": [
- {
- "id": "string"
}
], - "instrumentId": "string",
- "techniques": [
- {
- "pid": "string",
- "name": "string"
}
]
}| id required | string <JSON> Model id |
Model instance data
| pid required | string Persistent Identifier for datasets derived from UUIDv4 and prepended automatically by site specific PID prefix like 20.500.12345/ |
| owner required | string Owner of the data set, usually first name + lastname |
| ownerEmail | string Email of owner of the data set |
| orcidOfOwner | string ORCID of owner https://orcid.org if available |
| contactEmail required | string Email of contact person for this dataset |
| sourceFolder required | string Absolute file path on file server containing the files of this dataset, e.g. /some/path/to/sourcefolder. In case of a single file dataset, e.g. HDF5 data, it contains the path up to, but excluding the filename. Trailing slashes are removed. |
| sourceFolderHost | string DNS host name of file server hosting sourceFolder, optionally including protocol e.g. [protocol://]fileserver1.example.com |
| size | number <double> Total size of all source files contained in source folder on disk when unpacked |
| packedSize | number <double> Total size of all datablock package files created for this dataset |
| numberOfFiles | number <double> Total number of lines in filelisting of all OrigDatablocks for this dataset |
| numberOfFilesArchived | number <double> Total number of lines in filelisting of all Datablocks for this dataset |
| creationTime required | string <date-time> Time when dataset became fully available on disk, i.e. all containing files have been written. Format according to chapter 5.6 internet date/time format in RFC 3339. Local times without timezone/offset info are automatically transformed to UTC using the timezone of the API server. |
| type required | string Characterize type of dataset, either 'base' or 'raw' or 'derived'. Autofilled when choosing the proper inherited models |
| validationStatus | string Defines a level of trust, e.g. a measure of how much data was verified or used by other persons |
| keywords | Array of strings Array of tags associated with the meaning or contents of this dataset. Values should ideally come from defined vocabularies, taxonomies, ontologies or knowledge graphs |
| description | string Free text explanation of contents of dataset |
| datasetName | string A name for the dataset, given by the creator to carry some semantic meaning. Useful for display purposes e.g. instead of displaying the pid. Will be autofilled if missing using info from sourceFolder |
| classification | string ACIA information about AUthenticity,COnfidentiality,INtegrity and AVailability requirements of dataset. E.g. AV(ailabilty)=medium could trigger the creation of a two tape copies. Format 'AV=medium,CO=low' |
| license | string Name of license under which data can be used |
| version | string Version of API used in creation of dataset |
| isPublished | boolean Flag is true when data are made publically available |
| ownerGroup required | string Defines the group which owns the data, and therefore has unrestricted access to this data. Usually a pgroup like p12151 |
| accessGroups | Array of strings Optional additional groups which have read access to the data. Users which are member in one of the groups listed here are allowed to access this data. The special group 'public' makes data available to all users |
| createdBy | string Functional or user account name who created this instance |
| updatedBy | string Functional or user account name who last updated this instance |
| createdAt | string <date-time> |
| updatedAt | string <date-time> |
| publishedDataId | string |
| publisheddataId | string |
object (DatasetLifecycle) For each dataset there exists an embedded dataset lifecycle document which describes the current status of the dataset during its lifetime with respect to the storage handling systems | |
Array of objects (Message) | |
| instrumentId | string |
Array of objects (Technique) |
{- "pid": "string",
- "owner": "string",
- "ownerEmail": "string",
- "orcidOfOwner": "string",
- "contactEmail": "string",
- "sourceFolder": "string",
- "sourceFolderHost": "string",
- "size": 0,
- "packedSize": 0,
- "numberOfFiles": 0,
- "numberOfFilesArchived": 0,
- "creationTime": "2019-08-24T14:15:22Z",
- "type": "string",
- "validationStatus": "string",
- "keywords": [
- "string"
], - "description": "string",
- "datasetName": "string",
- "classification": "string",
- "license": "string",
- "version": "string",
- "isPublished": true,
- "ownerGroup": "string",
- "accessGroups": [
- "string"
], - "createdBy": "string",
- "updatedBy": "string",
- "createdAt": "2019-08-24T14:15:22Z",
- "updatedAt": "2019-08-24T14:15:22Z",
- "publishedDataId": "string",
- "publisheddataId": "string",
- "datasetlifecycle": {
- "archivable": true,
- "retrievable": true,
- "publishable": true,
- "dateOfDiskPurging": "2019-08-24T14:15:22Z",
- "archiveRetentionTime": "2019-08-24T14:15:22Z",
- "dateOfPublishing": "2019-08-24T14:15:22Z",
- "isOnCentralDisk": true,
- "archiveStatusMessage": "string",
- "retrieveStatusMessage": "string",
- "archiveReturnMessage": { },
- "retrieveReturnMessage": { },
- "exportedTo": "string",
- "retrieveIntegrityCheck": true,
- "id": "string"
}, - "history": [
- {
- "id": "string"
}
], - "instrumentId": "string",
- "techniques": [
- {
- "pid": "string",
- "name": "string"
}
]
}{- "pid": "string",
- "owner": "string",
- "ownerEmail": "string",
- "orcidOfOwner": "string",
- "contactEmail": "string",
- "sourceFolder": "string",
- "sourceFolderHost": "string",
- "size": 0,
- "packedSize": 0,
- "numberOfFiles": 0,
- "numberOfFilesArchived": 0,
- "creationTime": "2019-08-24T14:15:22Z",
- "type": "string",
- "validationStatus": "string",
- "keywords": [
- "string"
], - "description": "string",
- "datasetName": "string",
- "classification": "string",
- "license": "string",
- "version": "string",
- "isPublished": true,
- "ownerGroup": "string",
- "accessGroups": [
- "string"
], - "createdBy": "string",
- "updatedBy": "string",
- "createdAt": "2019-08-24T14:15:22Z",
- "updatedAt": "2019-08-24T14:15:22Z",
- "publishedDataId": "string",
- "publisheddataId": "string",
- "datasetlifecycle": {
- "archivable": true,
- "retrievable": true,
- "publishable": true,
- "dateOfDiskPurging": "2019-08-24T14:15:22Z",
- "archiveRetentionTime": "2019-08-24T14:15:22Z",
- "dateOfPublishing": "2019-08-24T14:15:22Z",
- "isOnCentralDisk": true,
- "archiveStatusMessage": "string",
- "retrieveStatusMessage": "string",
- "archiveReturnMessage": { },
- "retrieveReturnMessage": { },
- "exportedTo": "string",
- "retrieveIntegrityCheck": true,
- "id": "string"
}, - "history": [
- {
- "id": "string"
}
], - "instrumentId": "string",
- "techniques": [
- {
- "pid": "string",
- "name": "string"
}
]
}| filter | string <JSON> Filter defining fields, where, include, order, offset, and limit - must be a JSON-encoded string ( |
{- "pid": "string",
- "owner": "string",
- "ownerEmail": "string",
- "orcidOfOwner": "string",
- "contactEmail": "string",
- "sourceFolder": "string",
- "sourceFolderHost": "string",
- "size": 0,
- "packedSize": 0,
- "numberOfFiles": 0,
- "numberOfFilesArchived": 0,
- "creationTime": "2019-08-24T14:15:22Z",
- "type": "string",
- "validationStatus": "string",
- "keywords": [
- "string"
], - "description": "string",
- "datasetName": "string",
- "classification": "string",
- "license": "string",
- "version": "string",
- "isPublished": true,
- "ownerGroup": "string",
- "accessGroups": [
- "string"
], - "createdBy": "string",
- "updatedBy": "string",
- "createdAt": "2019-08-24T14:15:22Z",
- "updatedAt": "2019-08-24T14:15:22Z",
- "publishedDataId": "string",
- "publisheddataId": "string",
- "datasetlifecycle": {
- "archivable": true,
- "retrievable": true,
- "publishable": true,
- "dateOfDiskPurging": "2019-08-24T14:15:22Z",
- "archiveRetentionTime": "2019-08-24T14:15:22Z",
- "dateOfPublishing": "2019-08-24T14:15:22Z",
- "isOnCentralDisk": true,
- "archiveStatusMessage": "string",
- "retrieveStatusMessage": "string",
- "archiveReturnMessage": { },
- "retrieveReturnMessage": { },
- "exportedTo": "string",
- "retrieveIntegrityCheck": true,
- "id": "string"
}, - "history": [
- {
- "id": "string"
}
], - "instrumentId": "string",
- "techniques": [
- {
- "pid": "string",
- "name": "string"
}
]
}| where | string <JSON> Criteria to match model instances |
An object of model property name/value pairs
| pid required | string Persistent Identifier for datasets derived from UUIDv4 and prepended automatically by site specific PID prefix like 20.500.12345/ |
| owner required | string Owner of the data set, usually first name + lastname |
| ownerEmail | string Email of owner of the data set |
| orcidOfOwner | string ORCID of owner https://orcid.org if available |
| contactEmail required | string Email of contact person for this dataset |
| sourceFolder required | string Absolute file path on file server containing the files of this dataset, e.g. /some/path/to/sourcefolder. In case of a single file dataset, e.g. HDF5 data, it contains the path up to, but excluding the filename. Trailing slashes are removed. |
| sourceFolderHost | string DNS host name of file server hosting sourceFolder, optionally including protocol e.g. [protocol://]fileserver1.example.com |
| size | number <double> Total size of all source files contained in source folder on disk when unpacked |
| packedSize | number <double> Total size of all datablock package files created for this dataset |
| numberOfFiles | number <double> Total number of lines in filelisting of all OrigDatablocks for this dataset |
| numberOfFilesArchived | number <double> Total number of lines in filelisting of all Datablocks for this dataset |
| creationTime required | string <date-time> Time when dataset became fully available on disk, i.e. all containing files have been written. Format according to chapter 5.6 internet date/time format in RFC 3339. Local times without timezone/offset info are automatically transformed to UTC using the timezone of the API server. |
| type required | string Characterize type of dataset, either 'base' or 'raw' or 'derived'. Autofilled when choosing the proper inherited models |
| validationStatus | string Defines a level of trust, e.g. a measure of how much data was verified or used by other persons |
| keywords | Array of strings Array of tags associated with the meaning or contents of this dataset. Values should ideally come from defined vocabularies, taxonomies, ontologies or knowledge graphs |
| description | string Free text explanation of contents of dataset |
| datasetName | string A name for the dataset, given by the creator to carry some semantic meaning. Useful for display purposes e.g. instead of displaying the pid. Will be autofilled if missing using info from sourceFolder |
| classification | string ACIA information about AUthenticity,COnfidentiality,INtegrity and AVailability requirements of dataset. E.g. AV(ailabilty)=medium could trigger the creation of a two tape copies. Format 'AV=medium,CO=low' |
| license | string Name of license under which data can be used |
| version | string Version of API used in creation of dataset |
| isPublished | boolean Flag is true when data are made publically available |
| ownerGroup required | string Defines the group which owns the data, and therefore has unrestricted access to this data. Usually a pgroup like p12151 |
| accessGroups | Array of strings Optional additional groups which have read access to the data. Users which are member in one of the groups listed here are allowed to access this data. The special group 'public' makes data available to all users |
| createdBy | string Functional or user account name who created this instance |
| updatedBy | string Functional or user account name who last updated this instance |
| createdAt | string <date-time> |
| updatedAt | string <date-time> |
| publishedDataId | string |
| publisheddataId | string |
object (DatasetLifecycle) For each dataset there exists an embedded dataset lifecycle document which describes the current status of the dataset during its lifetime with respect to the storage handling systems | |
Array of objects (Message) | |
| instrumentId | string |
Array of objects (Technique) |
{- "pid": "string",
- "owner": "string",
- "ownerEmail": "string",
- "orcidOfOwner": "string",
- "contactEmail": "string",
- "sourceFolder": "string",
- "sourceFolderHost": "string",
- "size": 0,
- "packedSize": 0,
- "numberOfFiles": 0,
- "numberOfFilesArchived": 0,
- "creationTime": "2019-08-24T14:15:22Z",
- "type": "string",
- "validationStatus": "string",
- "keywords": [
- "string"
], - "description": "string",
- "datasetName": "string",
- "classification": "string",
- "license": "string",
- "version": "string",
- "isPublished": true,
- "ownerGroup": "string",
- "accessGroups": [
- "string"
], - "createdBy": "string",
- "updatedBy": "string",
- "createdAt": "2019-08-24T14:15:22Z",
- "updatedAt": "2019-08-24T14:15:22Z",
- "publishedDataId": "string",
- "publisheddataId": "string",
- "datasetlifecycle": {
- "archivable": true,
- "retrievable": true,
- "publishable": true,
- "dateOfDiskPurging": "2019-08-24T14:15:22Z",
- "archiveRetentionTime": "2019-08-24T14:15:22Z",
- "dateOfPublishing": "2019-08-24T14:15:22Z",
- "isOnCentralDisk": true,
- "archiveStatusMessage": "string",
- "retrieveStatusMessage": "string",
- "archiveReturnMessage": { },
- "retrieveReturnMessage": { },
- "exportedTo": "string",
- "retrieveIntegrityCheck": true,
- "id": "string"
}, - "history": [
- {
- "id": "string"
}
], - "instrumentId": "string",
- "techniques": [
- {
- "pid": "string",
- "name": "string"
}
]
}{- "count": 0
}{ }{ }| datasetId | string |
{ }| fields | string <JSON> Define the filter conditions by specifying the name and values of fields. There ia also support for a |
| facets | string <JSON> Defines list of field names, for which facet counts should be calculated |
{ }| fields | string <JSON> Define the filter conditions by specifying the name of values of fields requested. There ia also support for a |
| limits | string <JSON> Define further query parameters like skip, limit, order |
{ }| fields | string <JSON> Define the filter conditions by specifying the name of values of fields requested. There ia also support for a |
| limits | string <JSON> Define further query parameters like skip, limit, order |
{ }| id required | string |
| fieldName required | string Name of field to append data to |
| data required | string <JSON> An array of values to append |
{ }| fields | string <JSON> Define the filter conditions by specifying the name of values of fields requested. There is also support for a |
| limits | string <JSON> Define further query parameters like skip, limit, order |
{ }The Dataset to send for reduction
| pid required | string Persistent Identifier for datasets derived from UUIDv4 and prepended automatically by site specific PID prefix like 20.500.12345/ |
| owner required | string Owner of the data set, usually first name + lastname |
| ownerEmail | string Email of owner of the data set |
| orcidOfOwner | string ORCID of owner https://orcid.org if available |
| contactEmail required | string Email of contact person for this dataset |
| sourceFolder required | string Absolute file path on file server containing the files of this dataset, e.g. /some/path/to/sourcefolder. In case of a single file dataset, e.g. HDF5 data, it contains the path up to, but excluding the filename. Trailing slashes are removed. |
| sourceFolderHost | string DNS host name of file server hosting sourceFolder, optionally including protocol e.g. [protocol://]fileserver1.example.com |
| size | number <double> Total size of all source files contained in source folder on disk when unpacked |
| packedSize | number <double> Total size of all datablock package files created for this dataset |
| numberOfFiles | number <double> Total number of lines in filelisting of all OrigDatablocks for this dataset |
| numberOfFilesArchived | number <double> Total number of lines in filelisting of all Datablocks for this dataset |
| creationTime required | string <date-time> Time when dataset became fully available on disk, i.e. all containing files have been written. Format according to chapter 5.6 internet date/time format in RFC 3339. Local times without timezone/offset info are automatically transformed to UTC using the timezone of the API server. |
| type required | string Characterize type of dataset, either 'base' or 'raw' or 'derived'. Autofilled when choosing the proper inherited models |
| validationStatus | string Defines a level of trust, e.g. a measure of how much data was verified or used by other persons |
| keywords | Array of strings Array of tags associated with the meaning or contents of this dataset. Values should ideally come from defined vocabularies, taxonomies, ontologies or knowledge graphs |
| description | string Free text explanation of contents of dataset |
| datasetName | string A name for the dataset, given by the creator to carry some semantic meaning. Useful for display purposes e.g. instead of displaying the pid. Will be autofilled if missing using info from sourceFolder |
| classification | string ACIA information about AUthenticity,COnfidentiality,INtegrity and AVailability requirements of dataset. E.g. AV(ailabilty)=medium could trigger the creation of a two tape copies. Format 'AV=medium,CO=low' |
| license | string Name of license under which data can be used |
| version | string Version of API used in creation of dataset |
| isPublished | boolean Flag is true when data are made publically available |
| ownerGroup required | string Defines the group which owns the data, and therefore has unrestricted access to this data. Usually a pgroup like p12151 |
| accessGroups | Array of strings Optional additional groups which have read access to the data. Users which are member in one of the groups listed here are allowed to access this data. The special group 'public' makes data available to all users |
| createdBy | string Functional or user account name who created this instance |
| updatedBy | string Functional or user account name who last updated this instance |
| createdAt | string <date-time> |
| updatedAt | string <date-time> |
| publishedDataId | string |
| publisheddataId | string |
object (DatasetLifecycle) For each dataset there exists an embedded dataset lifecycle document which describes the current status of the dataset during its lifetime with respect to the storage handling systems | |
Array of objects (Message) | |
| instrumentId | string |
Array of objects (Technique) |
{- "pid": "string",
- "owner": "string",
- "ownerEmail": "string",
- "orcidOfOwner": "string",
- "contactEmail": "string",
- "sourceFolder": "string",
- "sourceFolderHost": "string",
- "size": 0,
- "packedSize": 0,
- "numberOfFiles": 0,
- "numberOfFilesArchived": 0,
- "creationTime": "2019-08-24T14:15:22Z",
- "type": "string",
- "validationStatus": "string",
- "keywords": [
- "string"
], - "description": "string",
- "datasetName": "string",
- "classification": "string",
- "license": "string",
- "version": "string",
- "isPublished": true,
- "ownerGroup": "string",
- "accessGroups": [
- "string"
], - "createdBy": "string",
- "updatedBy": "string",
- "createdAt": "2019-08-24T14:15:22Z",
- "updatedAt": "2019-08-24T14:15:22Z",
- "publishedDataId": "string",
- "publisheddataId": "string",
- "datasetlifecycle": {
- "archivable": true,
- "retrievable": true,
- "publishable": true,
- "dateOfDiskPurging": "2019-08-24T14:15:22Z",
- "archiveRetentionTime": "2019-08-24T14:15:22Z",
- "dateOfPublishing": "2019-08-24T14:15:22Z",
- "isOnCentralDisk": true,
- "archiveStatusMessage": "string",
- "retrieveStatusMessage": "string",
- "archiveReturnMessage": { },
- "retrieveReturnMessage": { },
- "exportedTo": "string",
- "retrieveIntegrityCheck": true,
- "id": "string"
}, - "history": [
- {
- "id": "string"
}
], - "instrumentId": "string",
- "techniques": [
- {
- "pid": "string",
- "name": "string"
}
]
}{ }Contains the information for datasets which are the result of measurements or of simulations. Often raw datasets are automatically added as part of an automated ingest step as part of the data acquisition chain at an instrument. This schema inherits the fields from the generic Dataset collection and adds specific fields as defined below.
| id required | string <JSON> RawDataset id |
| fk required | string <JSON> Foreign key for samples |
{- "sampleId": "string",
- "owner": "string",
- "description": "string",
- "createdAt": "2019-08-24T14:15:22Z",
- "sampleCharacteristics": { },
- "isPublished": true,
- "ownerGroup": "string",
- "accessGroups": [
- "string"
], - "createdBy": "string",
- "updatedBy": "string",
- "datasetsId": "string",
- "datasetId": "string",
- "rawDatasetId": "string",
- "derivedDatasetId": "string",
- "updatedAt": "2019-08-24T14:15:22Z"
}| id required | string <JSON> RawDataset id |
| fk required | string <JSON> Foreign key for samples |
| sampleId required | string |
| owner | string |
| description | string |
| createdAt | string <date-time> |
| sampleCharacteristics | object |
| isPublished | boolean Flag is true when data are made publically available |
| ownerGroup required | string Defines the group which owns the data, and therefore has unrestricted access to this data. Usually a pgroup like p12151 |
| accessGroups | Array of strings Optional additional groups which have read access to the data. Users which are member in one of the groups listed here are allowed to access this data. The special group 'public' makes data available to all users |
| createdBy | string Functional or user account name who created this instance |
| updatedBy | string Functional or user account name who last updated this instance |
| datasetsId | string |
| datasetId | string |
| rawDatasetId | string |
| derivedDatasetId | string |
| updatedAt | string <date-time> |
{- "sampleId": "string",
- "owner": "string",
- "description": "string",
- "createdAt": "2019-08-24T14:15:22Z",
- "sampleCharacteristics": { },
- "isPublished": true,
- "ownerGroup": "string",
- "accessGroups": [
- "string"
], - "createdBy": "string",
- "updatedBy": "string",
- "datasetsId": "string",
- "datasetId": "string",
- "rawDatasetId": "string",
- "derivedDatasetId": "string",
- "updatedAt": "2019-08-24T14:15:22Z"
}{- "sampleId": "string",
- "owner": "string",
- "description": "string",
- "createdAt": "2019-08-24T14:15:22Z",
- "sampleCharacteristics": { },
- "isPublished": true,
- "ownerGroup": "string",
- "accessGroups": [
- "string"
], - "createdBy": "string",
- "updatedBy": "string",
- "datasetsId": "string",
- "datasetId": "string",
- "rawDatasetId": "string",
- "derivedDatasetId": "string",
- "updatedAt": "2019-08-24T14:15:22Z"
}| id required | string <JSON> RawDataset id |
| refresh | boolean |
{- "sampleId": "string",
- "owner": "string",
- "description": "string",
- "createdAt": "2019-08-24T14:15:22Z",
- "sampleCharacteristics": { },
- "isPublished": true,
- "ownerGroup": "string",
- "accessGroups": [
- "string"
], - "createdBy": "string",
- "updatedBy": "string",
- "datasetsId": "string",
- "datasetId": "string",
- "rawDatasetId": "string",
- "derivedDatasetId": "string",
- "updatedAt": "2019-08-24T14:15:22Z"
}| id required | string <JSON> RawDataset id |
| refresh | boolean |
{- "proposalId": "string",
- "pi_email": "string",
- "pi_firstname": "string",
- "pi_lastname": "string",
- "email": "string",
- "firstname": "string",
- "lastname": "string",
- "title": "string",
- "abstract": "string",
- "startTime": "2019-08-24T14:15:22Z",
- "endTime": "2019-08-24T14:15:22Z",
- "ownerGroup": "string",
- "accessGroups": [
- "string"
], - "createdBy": "string",
- "updatedBy": "string",
- "createdAt": "2019-08-24T14:15:22Z",
- "updatedAt": "2019-08-24T14:15:22Z",
- "MeasurementPeriodList": [
- {
- "id": "string",
- "instrument": "string",
- "start": "2019-08-24T14:15:22Z",
- "end": "2019-08-24T14:15:22Z",
- "comment": "string"
}
]
}| id required | string <JSON> RawDataset id |
| refresh | boolean |
{- "doi": "string",
- "affiliation": "string",
- "creator": [
- "string"
], - "publisher": "string",
- "publicationYear": 0,
- "title": "string",
- "url": "string",
- "abstract": "string",
- "dataDescription": "string",
- "resourceType": "string",
- "numberOfFiles": 0,
- "sizeOfArchive": 0,
- "pidArray": [
- "string"
], - "authors": [
- "string"
], - "registeredTime": "2019-08-24T14:15:22Z",
- "status": "string",
- "scicatUser": "string",
- "thumbnail": "string",
- "relatedPublications": [
- "string"
], - "downloadLink": "string",
- "createdBy": "string",
- "updatedBy": "string",
- "createdAt": "2019-08-24T14:15:22Z",
- "updatedAt": "2019-08-24T14:15:22Z"
}| id required | string <JSON> RawDataset id |
| refresh | boolean |
{- "archivable": true,
- "retrievable": true,
- "publishable": true,
- "dateOfDiskPurging": "2019-08-24T14:15:22Z",
- "archiveRetentionTime": "2019-08-24T14:15:22Z",
- "dateOfPublishing": "2019-08-24T14:15:22Z",
- "isOnCentralDisk": true,
- "archiveStatusMessage": "string",
- "retrieveStatusMessage": "string",
- "archiveReturnMessage": { },
- "retrieveReturnMessage": { },
- "exportedTo": "string",
- "retrieveIntegrityCheck": true,
- "id": "string"
}| id required | string <JSON> RawDataset id |
| archivable | boolean Flag which is true, if dataset is available to be archived and no archive job for this dataset exists yet. |
| retrievable | boolean Flag which is true, if dataset is stored on archive system and is ready to be retrieved. |
| publishable | boolean Flag which is true, if dataset can be published. Usually requires a longterm storage option on tape or similar. |
| dateOfDiskPurging | string <date-time> Day when dataset will be removed from disk, assuming that is already stored on tape. |
| archiveRetentionTime | string <date-time> Day when the dataset's future fate will be evaluated again, e.g. to decide if the dataset can be deleted from archive. |
| dateOfPublishing | string <date-time> Day when dataset is supposed to become public according to data policy |
| isOnCentralDisk | boolean Flag which is true, if full dataset is available on central fileserver. If false data needs to be copied from decentral storage place to a cache server before the ingest. This information needs to be transferred to the archive system at archive time |
| archiveStatusMessage | string Short string defining current status of Dataset with respect to storage on disk/tape. |
| retrieveStatusMessage | string Latest message for this dataset concerning retrieve from archive system. |
| archiveReturnMessage | object Detailed status or error message returned by archive system when archiving this dataset. |
| retrieveReturnMessage | object Detailed status or error message returned by archive system when retrieving this dataset. |
| exportedTo | string Location of the last export destination. |
| retrieveIntegrityCheck | boolean Set to true when checksum tests after retrieve of datasets were successful |
| id | string |
{- "archivable": true,
- "retrievable": true,
- "publishable": true,
- "dateOfDiskPurging": "2019-08-24T14:15:22Z",
- "archiveRetentionTime": "2019-08-24T14:15:22Z",
- "dateOfPublishing": "2019-08-24T14:15:22Z",
- "isOnCentralDisk": true,
- "archiveStatusMessage": "string",
- "retrieveStatusMessage": "string",
- "archiveReturnMessage": { },
- "retrieveReturnMessage": { },
- "exportedTo": "string",
- "retrieveIntegrityCheck": true,
- "id": "string"
}{- "archivable": true,
- "retrievable": true,
- "publishable": true,
- "dateOfDiskPurging": "2019-08-24T14:15:22Z",
- "archiveRetentionTime": "2019-08-24T14:15:22Z",
- "dateOfPublishing": "2019-08-24T14:15:22Z",
- "isOnCentralDisk": true,
- "archiveStatusMessage": "string",
- "retrieveStatusMessage": "string",
- "archiveReturnMessage": { },
- "retrieveReturnMessage": { },
- "exportedTo": "string",
- "retrieveIntegrityCheck": true,
- "id": "string"
}| id required | string <JSON> RawDataset id |
| archivable | boolean Flag which is true, if dataset is available to be archived and no archive job for this dataset exists yet. |
| retrievable | boolean Flag which is true, if dataset is stored on archive system and is ready to be retrieved. |
| publishable | boolean Flag which is true, if dataset can be published. Usually requires a longterm storage option on tape or similar. |
| dateOfDiskPurging | string <date-time> Day when dataset will be removed from disk, assuming that is already stored on tape. |
| archiveRetentionTime | string <date-time> Day when the dataset's future fate will be evaluated again, e.g. to decide if the dataset can be deleted from archive. |
| dateOfPublishing | string <date-time> Day when dataset is supposed to become public according to data policy |
| isOnCentralDisk | boolean Flag which is true, if full dataset is available on central fileserver. If false data needs to be copied from decentral storage place to a cache server before the ingest. This information needs to be transferred to the archive system at archive time |
| archiveStatusMessage | string Short string defining current status of Dataset with respect to storage on disk/tape. |
| retrieveStatusMessage | string Latest message for this dataset concerning retrieve from archive system. |
| archiveReturnMessage | object Detailed status or error message returned by archive system when archiving this dataset. |
| retrieveReturnMessage | object Detailed status or error message returned by archive system when retrieving this dataset. |
| exportedTo | string Location of the last export destination. |
| retrieveIntegrityCheck | boolean Set to true when checksum tests after retrieve of datasets were successful |
| id | string |
{- "archivable": true,
- "retrievable": true,
- "publishable": true,
- "dateOfDiskPurging": "2019-08-24T14:15:22Z",
- "archiveRetentionTime": "2019-08-24T14:15:22Z",
- "dateOfPublishing": "2019-08-24T14:15:22Z",
- "isOnCentralDisk": true,
- "archiveStatusMessage": "string",
- "retrieveStatusMessage": "string",
- "archiveReturnMessage": { },
- "retrieveReturnMessage": { },
- "exportedTo": "string",
- "retrieveIntegrityCheck": true,
- "id": "string"
}{- "archivable": true,
- "retrievable": true,
- "publishable": true,
- "dateOfDiskPurging": "2019-08-24T14:15:22Z",
- "archiveRetentionTime": "2019-08-24T14:15:22Z",
- "dateOfPublishing": "2019-08-24T14:15:22Z",
- "isOnCentralDisk": true,
- "archiveStatusMessage": "string",
- "retrieveStatusMessage": "string",
- "archiveReturnMessage": { },
- "retrieveReturnMessage": { },
- "exportedTo": "string",
- "retrieveIntegrityCheck": true,
- "id": "string"
}| id required | string <JSON> RawDataset id |
| fk required | string <JSON> Foreign key for datablocks |
{- "id": "string",
- "archiveId": "string",
- "size": 0,
- "packedSize": 0,
- "chkAlg": "string",
- "version": "string",
- "dataFileList": [
- {
- "path": "string",
- "size": 0,
- "time": "2019-08-24T14:15:22Z",
- "chk": "string",
- "uid": "string",
- "gid": "string",
- "perm": "string"
}
], - "ownerGroup": "string",
- "accessGroups": [
- "string"
], - "createdBy": "string",
- "updatedBy": "string",
- "datasetId": "string",
- "rawDatasetId": "string",
- "derivedDatasetId": "string",
- "createdAt": "2019-08-24T14:15:22Z",
- "updatedAt": "2019-08-24T14:15:22Z"
}| id required | string <JSON> RawDataset id |
| fk required | string <JSON> Foreign key for datablocks |
| id required | string Catalog internal UUIDv4 for datablock |
| archiveId required | string Unique identifier given bey archive system to the stored datablock. This id is used when data is retrieved back. |
| size required | number <double> Total size in bytes of all files in datablock when unpacked |
| packedSize | number <double> Size of datablock package file |
| chkAlg | string Algoritm used for calculation of checksums, e.g. sha2 |
| version required | string Version string defining format of how data is packed and stored in archive |
required | Array of objects (Datafile) |
| ownerGroup required | string Defines the group which owns the data, and therefore has unrestricted access to this data. Usually a pgroup like p12151 |
| accessGroups | Array of strings Optional additional groups which have read access to the data. Users which are member in one of the groups listed here are allowed to access this data. The special group 'public' makes data available to all users |
| createdBy | string Functional or user account name who created this instance |
| updatedBy | string Functional or user account name who last updated this instance |
| datasetId | string |
| rawDatasetId | string |
| derivedDatasetId | string |
| createdAt | string <date-time> |
| updatedAt | string <date-time> |
{- "id": "string",
- "archiveId": "string",
- "size": 0,
- "packedSize": 0,
- "chkAlg": "string",
- "version": "string",
- "dataFileList": [
- {
- "path": "string",
- "size": 0,
- "time": "2019-08-24T14:15:22Z",
- "chk": "string",
- "uid": "string",
- "gid": "string",
- "perm": "string"
}
], - "ownerGroup": "string",
- "accessGroups": [
- "string"
], - "createdBy": "string",
- "updatedBy": "string",
- "datasetId": "string",
- "rawDatasetId": "string",
- "derivedDatasetId": "string",
- "createdAt": "2019-08-24T14:15:22Z",
- "updatedAt": "2019-08-24T14:15:22Z"
}{- "id": "string",
- "archiveId": "string",
- "size": 0,
- "packedSize": 0,
- "chkAlg": "string",
- "version": "string",
- "dataFileList": [
- {
- "path": "string",
- "size": 0,
- "time": "2019-08-24T14:15:22Z",
- "chk": "string",
- "uid": "string",
- "gid": "string",
- "perm": "string"
}
], - "ownerGroup": "string",
- "accessGroups": [
- "string"
], - "createdBy": "string",
- "updatedBy": "string",
- "datasetId": "string",
- "rawDatasetId": "string",
- "derivedDatasetId": "string",
- "createdAt": "2019-08-24T14:15:22Z",
- "updatedAt": "2019-08-24T14:15:22Z"
}| id required | string <JSON> RawDataset id |
| fk required | string <JSON> Foreign key for origdatablocks |
{- "id": "string",
- "size": 0,
- "dataFileList": [
- {
- "path": "string",
- "size": 0,
- "time": "2019-08-24T14:15:22Z",
- "chk": "string",
- "uid": "string",
- "gid": "string",
- "perm": "string"
}
], - "ownerGroup": "string",
- "accessGroups": [
- "string"
], - "createdBy": "string",
- "updatedBy": "string",
- "datasetId": "string",
- "rawDatasetId": "string",
- "derivedDatasetId": "string",
- "createdAt": "2019-08-24T14:15:22Z",
- "updatedAt": "2019-08-24T14:15:22Z"
}| id required | string <JSON> RawDataset id |
| fk required | string <JSON> Foreign key for origdatablocks |
| id | string (ObjectID) ^[a-fA-F\d]{24}$ |
| size required | number <double> Total size in bytes of all files contained in the dataFileList |
required | Array of objects (Datafile) List of files contained in the linked dataset. Files can be regular files, folders and softlinks. All file paths are relative paths with respect to the sourceFolder location of the linked dataset. |
| ownerGroup required | string Defines the group which owns the data, and therefore has unrestricted access to this data. Usually a pgroup like p12151 |
| accessGroups | Array of strings Optional additional groups which have read access to the data. Users which are member in one of the groups listed here are allowed to access this data. The special group 'public' makes data available to all users |
| createdBy | string Functional or user account name who created this instance |
| updatedBy | string Functional or user account name who last updated this instance |
| datasetId | string |
| rawDatasetId | string |
| derivedDatasetId | string |
| createdAt | string <date-time> |
| updatedAt | string <date-time> |
{- "id": "string",
- "size": 0,
- "dataFileList": [
- {
- "path": "string",
- "size": 0,
- "time": "2019-08-24T14:15:22Z",
- "chk": "string",
- "uid": "string",
- "gid": "string",
- "perm": "string"
}
], - "ownerGroup": "string",
- "accessGroups": [
- "string"
], - "createdBy": "string",
- "updatedBy": "string",
- "datasetId": "string",
- "rawDatasetId": "string",
- "derivedDatasetId": "string",
- "createdAt": "2019-08-24T14:15:22Z",
- "updatedAt": "2019-08-24T14:15:22Z"
}{- "id": "string",
- "size": 0,
- "dataFileList": [
- {
- "path": "string",
- "size": 0,
- "time": "2019-08-24T14:15:22Z",
- "chk": "string",
- "uid": "string",
- "gid": "string",
- "perm": "string"
}
], - "ownerGroup": "string",
- "accessGroups": [
- "string"
], - "createdBy": "string",
- "updatedBy": "string",
- "datasetId": "string",
- "rawDatasetId": "string",
- "derivedDatasetId": "string",
- "createdAt": "2019-08-24T14:15:22Z",
- "updatedAt": "2019-08-24T14:15:22Z"
}| id required | string <JSON> RawDataset id |
| fk required | string <JSON> Foreign key for historyList |
{- "id": "string"
}| id required | string <JSON> RawDataset id |
| fk required | string <JSON> Foreign key for historyList |
| id required | string id currently needed by limitation in embedsmany |
{- "id": "string"
}{- "id": "string"
}| id required | string <JSON> RawDataset id |
| fk required | string <JSON> Foreign key for attachments |
{- "thumbnail": "retrieve",
- "caption": "",
- "ownerGroup": "string",
- "accessGroups": [
- "string"
], - "createdBy": "string",
- "updatedBy": "string",
- "id": "string",
- "datasetId": "string",
- "sampleId": "string",
- "proposalId": "string",
- "rawDatasetId": "string",
- "derivedDatasetId": "string",
- "createdAt": "2019-08-24T14:15:22Z",
- "updatedAt": "2019-08-24T14:15:22Z"
}| id required | string <JSON> RawDataset id |
| fk required | string <JSON> Foreign key for attachments |
| thumbnail required | string Default: "retrieve" Contains a thumbnail preview in base64 encoded png format for a given dataset |
| caption | string Default: "" Attachment caption to show in catanie |
| ownerGroup required | string Defines the group which owns the data, and therefore has unrestricted access to this data. Usually a pgroup like p12151 |
| accessGroups | Array of strings Optional additional groups which have read access to the data. Users which are member in one of the groups listed here are allowed to access this data. The special group 'public' makes data available to all users |
| createdBy | string Functional or user account name who created this instance |
| updatedBy | string Functional or user account name who last updated this instance |
| id | string (ObjectID) ^[a-fA-F\d]{24}$ |
| datasetId | string |
| sampleId | string |
| proposalId | string |
| rawDatasetId | string |
| derivedDatasetId | string |
| createdAt | string <date-time> |
| updatedAt | string <date-time> |
{- "thumbnail": "retrieve",
- "caption": "",
- "ownerGroup": "string",
- "accessGroups": [
- "string"
], - "createdBy": "string",
- "updatedBy": "string",
- "id": "string",
- "datasetId": "string",
- "sampleId": "string",
- "proposalId": "string",
- "rawDatasetId": "string",
- "derivedDatasetId": "string",
- "createdAt": "2019-08-24T14:15:22Z",
- "updatedAt": "2019-08-24T14:15:22Z"
}{- "thumbnail": "retrieve",
- "caption": "",
- "ownerGroup": "string",
- "accessGroups": [
- "string"
], - "createdBy": "string",
- "updatedBy": "string",
- "id": "string",
- "datasetId": "string",
- "sampleId": "string",
- "proposalId": "string",
- "rawDatasetId": "string",
- "derivedDatasetId": "string",
- "createdAt": "2019-08-24T14:15:22Z",
- "updatedAt": "2019-08-24T14:15:22Z"
}| id required | string <JSON> RawDataset id |
| refresh | boolean |
{- "pid": "string",
- "name": "string",
- "customMetadata": { }
}| id required | string <JSON> RawDataset id |
| fk required | string <JSON> Foreign key for techniquesList |
{- "pid": "string",
- "name": "string"
}| id required | string <JSON> RawDataset id |
| fk required | string <JSON> Foreign key for techniquesList |
| pid required | string Persistent Identifier dervied from UUIDv4 |
| name required | string The name of the technique |
{- "pid": "string",
- "name": "string"
}{- "pid": "string",
- "name": "string"
}| id required | string <JSON> RawDataset id |
| filter | string <JSON> |
[- {
- "sampleId": "string",
- "owner": "string",
- "description": "string",
- "createdAt": "2019-08-24T14:15:22Z",
- "sampleCharacteristics": { },
- "isPublished": true,
- "ownerGroup": "string",
- "accessGroups": [
- "string"
], - "createdBy": "string",
- "updatedBy": "string",
- "datasetsId": "string",
- "datasetId": "string",
- "rawDatasetId": "string",
- "derivedDatasetId": "string",
- "updatedAt": "2019-08-24T14:15:22Z"
}
]| id required | string <JSON> RawDataset id |
| sampleId required | string |
| owner | string |
| description | string |
| createdAt | string <date-time> |
| sampleCharacteristics | object |
| isPublished | boolean Flag is true when data are made publically available |
| ownerGroup required | string Defines the group which owns the data, and therefore has unrestricted access to this data. Usually a pgroup like p12151 |
| accessGroups | Array of strings Optional additional groups which have read access to the data. Users which are member in one of the groups listed here are allowed to access this data. The special group 'public' makes data available to all users |
| createdBy | string Functional or user account name who created this instance |
| updatedBy | string Functional or user account name who last updated this instance |
| datasetsId | string |
| datasetId | string |
| rawDatasetId | string |
| derivedDatasetId | string |
| updatedAt | string <date-time> |
{- "sampleId": "string",
- "owner": "string",
- "description": "string",
- "createdAt": "2019-08-24T14:15:22Z",
- "sampleCharacteristics": { },
- "isPublished": true,
- "ownerGroup": "string",
- "accessGroups": [
- "string"
], - "createdBy": "string",
- "updatedBy": "string",
- "datasetsId": "string",
- "datasetId": "string",
- "rawDatasetId": "string",
- "derivedDatasetId": "string",
- "updatedAt": "2019-08-24T14:15:22Z"
}{- "sampleId": "string",
- "owner": "string",
- "description": "string",
- "createdAt": "2019-08-24T14:15:22Z",
- "sampleCharacteristics": { },
- "isPublished": true,
- "ownerGroup": "string",
- "accessGroups": [
- "string"
], - "createdBy": "string",
- "updatedBy": "string",
- "datasetsId": "string",
- "datasetId": "string",
- "rawDatasetId": "string",
- "derivedDatasetId": "string",
- "updatedAt": "2019-08-24T14:15:22Z"
}| id required | string <JSON> RawDataset id |
| where | string <JSON> Criteria to match model instances |
{- "count": 0
}| id required | string <JSON> RawDataset id |
| filter | string <JSON> |
[- {
- "id": "string",
- "archiveId": "string",
- "size": 0,
- "packedSize": 0,
- "chkAlg": "string",
- "version": "string",
- "dataFileList": [
- {
- "path": "string",
- "size": 0,
- "time": "2019-08-24T14:15:22Z",
- "chk": "string",
- "uid": "string",
- "gid": "string",
- "perm": "string"
}
], - "ownerGroup": "string",
- "accessGroups": [
- "string"
], - "createdBy": "string",
- "updatedBy": "string",
- "datasetId": "string",
- "rawDatasetId": "string",
- "derivedDatasetId": "string",
- "createdAt": "2019-08-24T14:15:22Z",
- "updatedAt": "2019-08-24T14:15:22Z"
}
]| id required | string <JSON> RawDataset id |
| id required | string Catalog internal UUIDv4 for datablock |
| archiveId required | string Unique identifier given bey archive system to the stored datablock. This id is used when data is retrieved back. |
| size required | number <double> Total size in bytes of all files in datablock when unpacked |
| packedSize | number <double> Size of datablock package file |
| chkAlg | string Algoritm used for calculation of checksums, e.g. sha2 |
| version required | string Version string defining format of how data is packed and stored in archive |
required | Array of objects (Datafile) |
| ownerGroup required | string Defines the group which owns the data, and therefore has unrestricted access to this data. Usually a pgroup like p12151 |
| accessGroups | Array of strings Optional additional groups which have read access to the data. Users which are member in one of the groups listed here are allowed to access this data. The special group 'public' makes data available to all users |
| createdBy | string Functional or user account name who created this instance |
| updatedBy | string Functional or user account name who last updated this instance |
| datasetId | string |
| rawDatasetId | string |
| derivedDatasetId | string |
| createdAt | string <date-time> |
| updatedAt | string <date-time> |
{- "id": "string",
- "archiveId": "string",
- "size": 0,
- "packedSize": 0,
- "chkAlg": "string",
- "version": "string",
- "dataFileList": [
- {
- "path": "string",
- "size": 0,
- "time": "2019-08-24T14:15:22Z",
- "chk": "string",
- "uid": "string",
- "gid": "string",
- "perm": "string"
}
], - "ownerGroup": "string",
- "accessGroups": [
- "string"
], - "createdBy": "string",
- "updatedBy": "string",
- "datasetId": "string",
- "rawDatasetId": "string",
- "derivedDatasetId": "string",
- "createdAt": "2019-08-24T14:15:22Z",
- "updatedAt": "2019-08-24T14:15:22Z"
}{- "id": "string",
- "archiveId": "string",
- "size": 0,
- "packedSize": 0,
- "chkAlg": "string",
- "version": "string",
- "dataFileList": [
- {
- "path": "string",
- "size": 0,
- "time": "2019-08-24T14:15:22Z",
- "chk": "string",
- "uid": "string",
- "gid": "string",
- "perm": "string"
}
], - "ownerGroup": "string",
- "accessGroups": [
- "string"
], - "createdBy": "string",
- "updatedBy": "string",
- "datasetId": "string",
- "rawDatasetId": "string",
- "derivedDatasetId": "string",
- "createdAt": "2019-08-24T14:15:22Z",
- "updatedAt": "2019-08-24T14:15:22Z"
}| id required | string <JSON> RawDataset id |
| where | string <JSON> Criteria to match model instances |
{- "count": 0
}| id required | string <JSON> RawDataset id |
| filter | string <JSON> |
[- {
- "id": "string",
- "size": 0,
- "dataFileList": [
- {
- "path": "string",
- "size": 0,
- "time": "2019-08-24T14:15:22Z",
- "chk": "string",
- "uid": "string",
- "gid": "string",
- "perm": "string"
}
], - "ownerGroup": "string",
- "accessGroups": [
- "string"
], - "createdBy": "string",
- "updatedBy": "string",
- "datasetId": "string",
- "rawDatasetId": "string",
- "derivedDatasetId": "string",
- "createdAt": "2019-08-24T14:15:22Z",
- "updatedAt": "2019-08-24T14:15:22Z"
}
]| id required | string <JSON> RawDataset id |
| id | string (ObjectID) ^[a-fA-F\d]{24}$ |
| size required | number <double> Total size in bytes of all files contained in the dataFileList |
required | Array of objects (Datafile) List of files contained in the linked dataset. Files can be regular files, folders and softlinks. All file paths are relative paths with respect to the sourceFolder location of the linked dataset. |
| ownerGroup required | string Defines the group which owns the data, and therefore has unrestricted access to this data. Usually a pgroup like p12151 |
| accessGroups | Array of strings Optional additional groups which have read access to the data. Users which are member in one of the groups listed here are allowed to access this data. The special group 'public' makes data available to all users |
| createdBy | string Functional or user account name who created this instance |
| updatedBy | string Functional or user account name who last updated this instance |
| datasetId | string |
| rawDatasetId | string |
| derivedDatasetId | string |
| createdAt | string <date-time> |
| updatedAt | string <date-time> |
{- "id": "string",
- "size": 0,
- "dataFileList": [
- {
- "path": "string",
- "size": 0,
- "time": "2019-08-24T14:15:22Z",
- "chk": "string",
- "uid": "string",
- "gid": "string",
- "perm": "string"
}
], - "ownerGroup": "string",
- "accessGroups": [
- "string"
], - "createdBy": "string",
- "updatedBy": "string",
- "datasetId": "string",
- "rawDatasetId": "string",
- "derivedDatasetId": "string",
- "createdAt": "2019-08-24T14:15:22Z",
- "updatedAt": "2019-08-24T14:15:22Z"
}{- "id": "string",
- "size": 0,
- "dataFileList": [
- {
- "path": "string",
- "size": 0,
- "time": "2019-08-24T14:15:22Z",
- "chk": "string",
- "uid": "string",
- "gid": "string",
- "perm": "string"
}
], - "ownerGroup": "string",
- "accessGroups": [
- "string"
], - "createdBy": "string",
- "updatedBy": "string",
- "datasetId": "string",
- "rawDatasetId": "string",
- "derivedDatasetId": "string",
- "createdAt": "2019-08-24T14:15:22Z",
- "updatedAt": "2019-08-24T14:15:22Z"
}| id required | string <JSON> RawDataset id |
| where | string <JSON> Criteria to match model instances |
{- "count": 0
}| id required | string <JSON> RawDataset id |
| id required | string id currently needed by limitation in embedsmany |
{- "id": "string"
}{- "id": "string"
}| id required | string <JSON> RawDataset id |
| where | string <JSON> Criteria to match model instances |
{- "count": 0
}| id required | string <JSON> RawDataset id |
| filter | string <JSON> |
[- {
- "thumbnail": "retrieve",
- "caption": "",
- "ownerGroup": "string",
- "accessGroups": [
- "string"
], - "createdBy": "string",
- "updatedBy": "string",
- "id": "string",
- "datasetId": "string",
- "sampleId": "string",
- "proposalId": "string",
- "rawDatasetId": "string",
- "derivedDatasetId": "string",
- "createdAt": "2019-08-24T14:15:22Z",
- "updatedAt": "2019-08-24T14:15:22Z"
}
]| id required | string <JSON> RawDataset id |
| thumbnail required | string Default: "retrieve" Contains a thumbnail preview in base64 encoded png format for a given dataset |
| caption | string Default: "" Attachment caption to show in catanie |
| ownerGroup required | string Defines the group which owns the data, and therefore has unrestricted access to this data. Usually a pgroup like p12151 |
| accessGroups | Array of strings Optional additional groups which have read access to the data. Users which are member in one of the groups listed here are allowed to access this data. The special group 'public' makes data available to all users |
| createdBy | string Functional or user account name who created this instance |
| updatedBy | string Functional or user account name who last updated this instance |
| id | string (ObjectID) ^[a-fA-F\d]{24}$ |
| datasetId | string |
| sampleId | string |
| proposalId | string |
| rawDatasetId | string |
| derivedDatasetId | string |
| createdAt | string <date-time> |
| updatedAt | string <date-time> |
{- "thumbnail": "retrieve",
- "caption": "",
- "ownerGroup": "string",
- "accessGroups": [
- "string"
], - "createdBy": "string",
- "updatedBy": "string",
- "id": "string",
- "datasetId": "string",
- "sampleId": "string",
- "proposalId": "string",
- "rawDatasetId": "string",
- "derivedDatasetId": "string",
- "createdAt": "2019-08-24T14:15:22Z",
- "updatedAt": "2019-08-24T14:15:22Z"
}{- "thumbnail": "retrieve",
- "caption": "",
- "ownerGroup": "string",
- "accessGroups": [
- "string"
], - "createdBy": "string",
- "updatedBy": "string",
- "id": "string",
- "datasetId": "string",
- "sampleId": "string",
- "proposalId": "string",
- "rawDatasetId": "string",
- "derivedDatasetId": "string",
- "createdAt": "2019-08-24T14:15:22Z",
- "updatedAt": "2019-08-24T14:15:22Z"
}| id required | string <JSON> RawDataset id |
| where | string <JSON> Criteria to match model instances |
{- "count": 0
}| id required | string <JSON> RawDataset id |
| pid required | string Persistent Identifier dervied from UUIDv4 |
| name required | string The name of the technique |
{- "pid": "string",
- "name": "string"
}{- "pid": "string",
- "name": "string"
}| id required | string <JSON> RawDataset id |
| where | string <JSON> Criteria to match model instances |
{- "count": 0
}Model instance data
| principalInvestigator required | string Email of principal investigator |
| endTime | string <date-time> Time of end of data taking for this dataset, format according to chapter 5.6 internet date/time format in RFC 3339. Local times without timezone/offset info are automatically transformed to UTC using the timezone of the API server |
| creationLocation required | string Unique location identifier where data was taken, usually in the form /Site-name/facility-name/instrumentOrBeamline-name |
| dataFormat | string Defines format of subsequent scientific meta data, e.g Nexus Version x.y |
| scientificMetadata | object JSON object containing the scientific meta data |
| pid required | string Persistent Identifier for datasets derived from UUIDv4 and prepended automatically by site specific PID prefix like 20.500.12345/ |
| owner required | string Owner of the data set, usually first name + lastname |
| ownerEmail | string Email of owner of the data set |
| orcidOfOwner | string ORCID of owner https://orcid.org if available |
| contactEmail required | string Email of contact person for this dataset |
| sourceFolder required | string Absolute file path on file server containing the files of this dataset, e.g. /some/path/to/sourcefolder. In case of a single file dataset, e.g. HDF5 data, it contains the path up to, but excluding the filename. Trailing slashes are removed. |
| sourceFolderHost | string DNS host name of file server hosting sourceFolder, optionally including protocol e.g. [protocol://]fileserver1.example.com |
| size | number <double> Total size of all source files contained in source folder on disk when unpacked |
| packedSize | number <double> Total size of all datablock package files created for this dataset |
| numberOfFiles | number <double> Total number of lines in filelisting of all OrigDatablocks for this dataset |
| numberOfFilesArchived | number <double> Total number of lines in filelisting of all Datablocks for this dataset |
| creationTime required | string <date-time> Time when dataset became fully available on disk, i.e. all containing files have been written. Format according to chapter 5.6 internet date/time format in RFC 3339. Local times without timezone/offset info are automatically transformed to UTC using the timezone of the API server. |
| type required | string Characterize type of dataset, either 'base' or 'raw' or 'derived'. Autofilled when choosing the proper inherited models |
| validationStatus | string Defines a level of trust, e.g. a measure of how much data was verified or used by other persons |
| keywords | Array of strings Array of tags associated with the meaning or contents of this dataset. Values should ideally come from defined vocabularies, taxonomies, ontologies or knowledge graphs |
| description | string Free text explanation of contents of dataset |
| datasetName | string A name for the dataset, given by the creator to carry some semantic meaning. Useful for display purposes e.g. instead of displaying the pid. Will be autofilled if missing using info from sourceFolder |
| classification | string ACIA information about AUthenticity,COnfidentiality,INtegrity and AVailability requirements of dataset. E.g. AV(ailabilty)=medium could trigger the creation of a two tape copies. Format 'AV=medium,CO=low' |
| license | string Name of license under which data can be used |
| version | string Version of API used in creation of dataset |
| isPublished | boolean Flag is true when data are made publically available |
| ownerGroup required | string Defines the group which owns the data, and therefore has unrestricted access to this data. Usually a pgroup like p12151 |
| accessGroups | Array of strings Optional additional groups which have read access to the data. Users which are member in one of the groups listed here are allowed to access this data. The special group 'public' makes data available to all users |
| createdBy | string Functional or user account name who created this instance |
| updatedBy | string Functional or user account name who last updated this instance |
| createdAt | string <date-time> |
| updatedAt | string <date-time> |
| sampleId | string |
| proposalId | string |
| publisheddataId | string |
object (DatasetLifecycle) For each dataset there exists an embedded dataset lifecycle document which describes the current status of the dataset during its lifetime with respect to the storage handling systems | |
Array of objects (Message) | |
| instrumentId | string |
Array of objects (Technique) |
{- "principalInvestigator": "string",
- "endTime": "2019-08-24T14:15:22Z",
- "creationLocation": "string",
- "dataFormat": "string",
- "scientificMetadata": { },
- "pid": "string",
- "owner": "string",
- "ownerEmail": "string",
- "orcidOfOwner": "string",
- "contactEmail": "string",
- "sourceFolder": "string",
- "sourceFolderHost": "string",
- "size": 0,
- "packedSize": 0,
- "numberOfFiles": 0,
- "numberOfFilesArchived": 0,
- "creationTime": "2019-08-24T14:15:22Z",
- "type": "string",
- "validationStatus": "string",
- "keywords": [
- "string"
], - "description": "string",
- "datasetName": "string",
- "classification": "string",
- "license": "string",
- "version": "string",
- "isPublished": true,
- "ownerGroup": "string",
- "accessGroups": [
- "string"
], - "createdBy": "string",
- "updatedBy": "string",
- "createdAt": "2019-08-24T14:15:22Z",
- "updatedAt": "2019-08-24T14:15:22Z",
- "sampleId": "string",
- "proposalId": "string",
- "publisheddataId": "string",
- "datasetlifecycle": {
- "archivable": true,
- "retrievable": true,
- "publishable": true,
- "dateOfDiskPurging": "2019-08-24T14:15:22Z",
- "archiveRetentionTime": "2019-08-24T14:15:22Z",
- "dateOfPublishing": "2019-08-24T14:15:22Z",
- "isOnCentralDisk": true,
- "archiveStatusMessage": "string",
- "retrieveStatusMessage": "string",
- "archiveReturnMessage": { },
- "retrieveReturnMessage": { },
- "exportedTo": "string",
- "retrieveIntegrityCheck": true,
- "id": "string"
}, - "history": [
- {
- "id": "string"
}
], - "instrumentId": "string",
- "techniques": [
- {
- "pid": "string",
- "name": "string"
}
]
}{- "principalInvestigator": "string",
- "endTime": "2019-08-24T14:15:22Z",
- "creationLocation": "string",
- "dataFormat": "string",
- "scientificMetadata": { },
- "pid": "string",
- "owner": "string",
- "ownerEmail": "string",
- "orcidOfOwner": "string",
- "contactEmail": "string",
- "sourceFolder": "string",
- "sourceFolderHost": "string",
- "size": 0,
- "packedSize": 0,
- "numberOfFiles": 0,
- "numberOfFilesArchived": 0,
- "creationTime": "2019-08-24T14:15:22Z",
- "type": "string",
- "validationStatus": "string",
- "keywords": [
- "string"
], - "description": "string",
- "datasetName": "string",
- "classification": "string",
- "license": "string",
- "version": "string",
- "isPublished": true,
- "ownerGroup": "string",
- "accessGroups": [
- "string"
], - "createdBy": "string",
- "updatedBy": "string",
- "createdAt": "2019-08-24T14:15:22Z",
- "updatedAt": "2019-08-24T14:15:22Z",
- "sampleId": "string",
- "proposalId": "string",
- "publisheddataId": "string",
- "datasetlifecycle": {
- "archivable": true,
- "retrievable": true,
- "publishable": true,
- "dateOfDiskPurging": "2019-08-24T14:15:22Z",
- "archiveRetentionTime": "2019-08-24T14:15:22Z",
- "dateOfPublishing": "2019-08-24T14:15:22Z",
- "isOnCentralDisk": true,
- "archiveStatusMessage": "string",
- "retrieveStatusMessage": "string",
- "archiveReturnMessage": { },
- "retrieveReturnMessage": { },
- "exportedTo": "string",
- "retrieveIntegrityCheck": true,
- "id": "string"
}, - "history": [
- {
- "id": "string"
}
], - "instrumentId": "string",
- "techniques": [
- {
- "pid": "string",
- "name": "string"
}
]
}Model instance data
| principalInvestigator required | string Email of principal investigator |
| endTime | string <date-time> Time of end of data taking for this dataset, format according to chapter 5.6 internet date/time format in RFC 3339. Local times without timezone/offset info are automatically transformed to UTC using the timezone of the API server |
| creationLocation required | string Unique location identifier where data was taken, usually in the form /Site-name/facility-name/instrumentOrBeamline-name |
| dataFormat | string Defines format of subsequent scientific meta data, e.g Nexus Version x.y |
| scientificMetadata | object JSON object containing the scientific meta data |
| pid required | string Persistent Identifier for datasets derived from UUIDv4 and prepended automatically by site specific PID prefix like 20.500.12345/ |
| owner required | string Owner of the data set, usually first name + lastname |
| ownerEmail | string Email of owner of the data set |
| orcidOfOwner | string ORCID of owner https://orcid.org if available |
| contactEmail required | string Email of contact person for this dataset |
| sourceFolder required | string Absolute file path on file server containing the files of this dataset, e.g. /some/path/to/sourcefolder. In case of a single file dataset, e.g. HDF5 data, it contains the path up to, but excluding the filename. Trailing slashes are removed. |
| sourceFolderHost | string DNS host name of file server hosting sourceFolder, optionally including protocol e.g. [protocol://]fileserver1.example.com |
| size | number <double> Total size of all source files contained in source folder on disk when unpacked |
| packedSize | number <double> Total size of all datablock package files created for this dataset |
| numberOfFiles | number <double> Total number of lines in filelisting of all OrigDatablocks for this dataset |
| numberOfFilesArchived | number <double> Total number of lines in filelisting of all Datablocks for this dataset |
| creationTime required | string <date-time> Time when dataset became fully available on disk, i.e. all containing files have been written. Format according to chapter 5.6 internet date/time format in RFC 3339. Local times without timezone/offset info are automatically transformed to UTC using the timezone of the API server. |
| type required | string Characterize type of dataset, either 'base' or 'raw' or 'derived'. Autofilled when choosing the proper inherited models |
| validationStatus | string Defines a level of trust, e.g. a measure of how much data was verified or used by other persons |
| keywords | Array of strings Array of tags associated with the meaning or contents of this dataset. Values should ideally come from defined vocabularies, taxonomies, ontologies or knowledge graphs |
| description | string Free text explanation of contents of dataset |
| datasetName | string A name for the dataset, given by the creator to carry some semantic meaning. Useful for display purposes e.g. instead of displaying the pid. Will be autofilled if missing using info from sourceFolder |
| classification | string ACIA information about AUthenticity,COnfidentiality,INtegrity and AVailability requirements of dataset. E.g. AV(ailabilty)=medium could trigger the creation of a two tape copies. Format 'AV=medium,CO=low' |
| license | string Name of license under which data can be used |
| version | string Version of API used in creation of dataset |
| isPublished | boolean Flag is true when data are made publically available |
| ownerGroup required | string Defines the group which owns the data, and therefore has unrestricted access to this data. Usually a pgroup like p12151 |
| accessGroups | Array of strings Optional additional groups which have read access to the data. Users which are member in one of the groups listed here are allowed to access this data. The special group 'public' makes data available to all users |
| createdBy | string Functional or user account name who created this instance |
| updatedBy | string Functional or user account name who last updated this instance |
| createdAt | string <date-time> |
| updatedAt | string <date-time> |
| sampleId | string |
| proposalId | string |
| publisheddataId | string |
object (DatasetLifecycle) For each dataset there exists an embedded dataset lifecycle document which describes the current status of the dataset during its lifetime with respect to the storage handling systems | |
Array of objects (Message) | |
| instrumentId | string |
Array of objects (Technique) |
{- "principalInvestigator": "string",
- "endTime": "2019-08-24T14:15:22Z",
- "creationLocation": "string",
- "dataFormat": "string",
- "scientificMetadata": { },
- "pid": "string",
- "owner": "string",
- "ownerEmail": "string",
- "orcidOfOwner": "string",
- "contactEmail": "string",
- "sourceFolder": "string",
- "sourceFolderHost": "string",
- "size": 0,
- "packedSize": 0,
- "numberOfFiles": 0,
- "numberOfFilesArchived": 0,
- "creationTime": "2019-08-24T14:15:22Z",
- "type": "string",
- "validationStatus": "string",
- "keywords": [
- "string"
], - "description": "string",
- "datasetName": "string",
- "classification": "string",
- "license": "string",
- "version": "string",
- "isPublished": true,
- "ownerGroup": "string",
- "accessGroups": [
- "string"
], - "createdBy": "string",
- "updatedBy": "string",
- "createdAt": "2019-08-24T14:15:22Z",
- "updatedAt": "2019-08-24T14:15:22Z",
- "sampleId": "string",
- "proposalId": "string",
- "publisheddataId": "string",
- "datasetlifecycle": {
- "archivable": true,
- "retrievable": true,
- "publishable": true,
- "dateOfDiskPurging": "2019-08-24T14:15:22Z",
- "archiveRetentionTime": "2019-08-24T14:15:22Z",
- "dateOfPublishing": "2019-08-24T14:15:22Z",
- "isOnCentralDisk": true,
- "archiveStatusMessage": "string",
- "retrieveStatusMessage": "string",
- "archiveReturnMessage": { },
- "retrieveReturnMessage": { },
- "exportedTo": "string",
- "retrieveIntegrityCheck": true,
- "id": "string"
}, - "history": [
- {
- "id": "string"
}
], - "instrumentId": "string",
- "techniques": [
- {
- "pid": "string",
- "name": "string"
}
]
}{- "principalInvestigator": "string",
- "endTime": "2019-08-24T14:15:22Z",
- "creationLocation": "string",
- "dataFormat": "string",
- "scientificMetadata": { },
- "pid": "string",
- "owner": "string",
- "ownerEmail": "string",
- "orcidOfOwner": "string",
- "contactEmail": "string",
- "sourceFolder": "string",
- "sourceFolderHost": "string",
- "size": 0,
- "packedSize": 0,
- "numberOfFiles": 0,
- "numberOfFilesArchived": 0,
- "creationTime": "2019-08-24T14:15:22Z",
- "type": "string",
- "validationStatus": "string",
- "keywords": [
- "string"
], - "description": "string",
- "datasetName": "string",
- "classification": "string",
- "license": "string",
- "version": "string",
- "isPublished": true,
- "ownerGroup": "string",
- "accessGroups": [
- "string"
], - "createdBy": "string",
- "updatedBy": "string",
- "createdAt": "2019-08-24T14:15:22Z",
- "updatedAt": "2019-08-24T14:15:22Z",
- "sampleId": "string",
- "proposalId": "string",
- "publisheddataId": "string",
- "datasetlifecycle": {
- "archivable": true,
- "retrievable": true,
- "publishable": true,
- "dateOfDiskPurging": "2019-08-24T14:15:22Z",
- "archiveRetentionTime": "2019-08-24T14:15:22Z",
- "dateOfPublishing": "2019-08-24T14:15:22Z",
- "isOnCentralDisk": true,
- "archiveStatusMessage": "string",
- "retrieveStatusMessage": "string",
- "archiveReturnMessage": { },
- "retrieveReturnMessage": { },
- "exportedTo": "string",
- "retrieveIntegrityCheck": true,
- "id": "string"
}, - "history": [
- {
- "id": "string"
}
], - "instrumentId": "string",
- "techniques": [
- {
- "pid": "string",
- "name": "string"
}
]
}Model instance data
| principalInvestigator required | string Email of principal investigator |
| endTime | string <date-time> Time of end of data taking for this dataset, format according to chapter 5.6 internet date/time format in RFC 3339. Local times without timezone/offset info are automatically transformed to UTC using the timezone of the API server |
| creationLocation required | string Unique location identifier where data was taken, usually in the form /Site-name/facility-name/instrumentOrBeamline-name |
| dataFormat | string Defines format of subsequent scientific meta data, e.g Nexus Version x.y |
| scientificMetadata | object JSON object containing the scientific meta data |
| pid required | string Persistent Identifier for datasets derived from UUIDv4 and prepended automatically by site specific PID prefix like 20.500.12345/ |
| owner required | string Owner of the data set, usually first name + lastname |
| ownerEmail | string Email of owner of the data set |
| orcidOfOwner | string ORCID of owner https://orcid.org if available |
| contactEmail required | string Email of contact person for this dataset |
| sourceFolder required | string Absolute file path on file server containing the files of this dataset, e.g. /some/path/to/sourcefolder. In case of a single file dataset, e.g. HDF5 data, it contains the path up to, but excluding the filename. Trailing slashes are removed. |
| sourceFolderHost | string DNS host name of file server hosting sourceFolder, optionally including protocol e.g. [protocol://]fileserver1.example.com |
| size | number <double> Total size of all source files contained in source folder on disk when unpacked |
| packedSize | number <double> Total size of all datablock package files created for this dataset |
| numberOfFiles | number <double> Total number of lines in filelisting of all OrigDatablocks for this dataset |
| numberOfFilesArchived | number <double> Total number of lines in filelisting of all Datablocks for this dataset |
| creationTime required | string <date-time> Time when dataset became fully available on disk, i.e. all containing files have been written. Format according to chapter 5.6 internet date/time format in RFC 3339. Local times without timezone/offset info are automatically transformed to UTC using the timezone of the API server. |
| type required | string Characterize type of dataset, either 'base' or 'raw' or 'derived'. Autofilled when choosing the proper inherited models |
| validationStatus | string Defines a level of trust, e.g. a measure of how much data was verified or used by other persons |
| keywords | Array of strings Array of tags associated with the meaning or contents of this dataset. Values should ideally come from defined vocabularies, taxonomies, ontologies or knowledge graphs |
| description | string Free text explanation of contents of dataset |
| datasetName | string A name for the dataset, given by the creator to carry some semantic meaning. Useful for display purposes e.g. instead of displaying the pid. Will be autofilled if missing using info from sourceFolder |
| classification | string ACIA information about AUthenticity,COnfidentiality,INtegrity and AVailability requirements of dataset. E.g. AV(ailabilty)=medium could trigger the creation of a two tape copies. Format 'AV=medium,CO=low' |
| license | string Name of license under which data can be used |
| version | string Version of API used in creation of dataset |
| isPublished | boolean Flag is true when data are made publically available |
| ownerGroup required | string Defines the group which owns the data, and therefore has unrestricted access to this data. Usually a pgroup like p12151 |
| accessGroups | Array of strings Optional additional groups which have read access to the data. Users which are member in one of the groups listed here are allowed to access this data. The special group 'public' makes data available to all users |
| createdBy | string Functional or user account name who created this instance |
| updatedBy | string Functional or user account name who last updated this instance |
| createdAt | string <date-time> |
| updatedAt | string <date-time> |
| sampleId | string |
| proposalId | string |
| publisheddataId | string |
object (DatasetLifecycle) For each dataset there exists an embedded dataset lifecycle document which describes the current status of the dataset during its lifetime with respect to the storage handling systems | |
Array of objects (Message) | |
| instrumentId | string |
Array of objects (Technique) |
{- "principalInvestigator": "string",
- "endTime": "2019-08-24T14:15:22Z",
- "creationLocation": "string",
- "dataFormat": "string",
- "scientificMetadata": { },
- "pid": "string",
- "owner": "string",
- "ownerEmail": "string",
- "orcidOfOwner": "string",
- "contactEmail": "string",
- "sourceFolder": "string",
- "sourceFolderHost": "string",
- "size": 0,
- "packedSize": 0,
- "numberOfFiles": 0,
- "numberOfFilesArchived": 0,
- "creationTime": "2019-08-24T14:15:22Z",
- "type": "string",
- "validationStatus": "string",
- "keywords": [
- "string"
], - "description": "string",
- "datasetName": "string",
- "classification": "string",
- "license": "string",
- "version": "string",
- "isPublished": true,
- "ownerGroup": "string",
- "accessGroups": [
- "string"
], - "createdBy": "string",
- "updatedBy": "string",
- "createdAt": "2019-08-24T14:15:22Z",
- "updatedAt": "2019-08-24T14:15:22Z",
- "sampleId": "string",
- "proposalId": "string",
- "publisheddataId": "string",
- "datasetlifecycle": {
- "archivable": true,
- "retrievable": true,
- "publishable": true,
- "dateOfDiskPurging": "2019-08-24T14:15:22Z",
- "archiveRetentionTime": "2019-08-24T14:15:22Z",
- "dateOfPublishing": "2019-08-24T14:15:22Z",
- "isOnCentralDisk": true,
- "archiveStatusMessage": "string",
- "retrieveStatusMessage": "string",
- "archiveReturnMessage": { },
- "retrieveReturnMessage": { },
- "exportedTo": "string",
- "retrieveIntegrityCheck": true,
- "id": "string"
}, - "history": [
- {
- "id": "string"
}
], - "instrumentId": "string",
- "techniques": [
- {
- "pid": "string",
- "name": "string"
}
]
}{- "principalInvestigator": "string",
- "endTime": "2019-08-24T14:15:22Z",
- "creationLocation": "string",
- "dataFormat": "string",
- "scientificMetadata": { },
- "pid": "string",
- "owner": "string",
- "ownerEmail": "string",
- "orcidOfOwner": "string",
- "contactEmail": "string",
- "sourceFolder": "string",
- "sourceFolderHost": "string",
- "size": 0,
- "packedSize": 0,
- "numberOfFiles": 0,
- "numberOfFilesArchived": 0,
- "creationTime": "2019-08-24T14:15:22Z",
- "type": "string",
- "validationStatus": "string",
- "keywords": [
- "string"
], - "description": "string",
- "datasetName": "string",
- "classification": "string",
- "license": "string",
- "version": "string",
- "isPublished": true,
- "ownerGroup": "string",
- "accessGroups": [
- "string"
], - "createdBy": "string",
- "updatedBy": "string",
- "createdAt": "2019-08-24T14:15:22Z",
- "updatedAt": "2019-08-24T14:15:22Z",
- "sampleId": "string",
- "proposalId": "string",
- "publisheddataId": "string",
- "datasetlifecycle": {
- "archivable": true,
- "retrievable": true,
- "publishable": true,
- "dateOfDiskPurging": "2019-08-24T14:15:22Z",
- "archiveRetentionTime": "2019-08-24T14:15:22Z",
- "dateOfPublishing": "2019-08-24T14:15:22Z",
- "isOnCentralDisk": true,
- "archiveStatusMessage": "string",
- "retrieveStatusMessage": "string",
- "archiveReturnMessage": { },
- "retrieveReturnMessage": { },
- "exportedTo": "string",
- "retrieveIntegrityCheck": true,
- "id": "string"
}, - "history": [
- {
- "id": "string"
}
], - "instrumentId": "string",
- "techniques": [
- {
- "pid": "string",
- "name": "string"
}
]
}| filter | string <JSON> Filter defining fields, where, include, order, offset, and limit - must be a JSON-encoded string ( |
[- {
- "principalInvestigator": "string",
- "endTime": "2019-08-24T14:15:22Z",
- "creationLocation": "string",
- "dataFormat": "string",
- "scientificMetadata": { },
- "pid": "string",
- "owner": "string",
- "ownerEmail": "string",
- "orcidOfOwner": "string",
- "contactEmail": "string",
- "sourceFolder": "string",
- "sourceFolderHost": "string",
- "size": 0,
- "packedSize": 0,
- "numberOfFiles": 0,
- "numberOfFilesArchived": 0,
- "creationTime": "2019-08-24T14:15:22Z",
- "type": "string",
- "validationStatus": "string",
- "keywords": [
- "string"
], - "description": "string",
- "datasetName": "string",
- "classification": "string",
- "license": "string",
- "version": "string",
- "isPublished": true,
- "ownerGroup": "string",
- "accessGroups": [
- "string"
], - "createdBy": "string",
- "updatedBy": "string",
- "createdAt": "2019-08-24T14:15:22Z",
- "updatedAt": "2019-08-24T14:15:22Z",
- "sampleId": "string",
- "proposalId": "string",
- "publisheddataId": "string",
- "datasetlifecycle": {
- "archivable": true,
- "retrievable": true,
- "publishable": true,
- "dateOfDiskPurging": "2019-08-24T14:15:22Z",
- "archiveRetentionTime": "2019-08-24T14:15:22Z",
- "dateOfPublishing": "2019-08-24T14:15:22Z",
- "isOnCentralDisk": true,
- "archiveStatusMessage": "string",
- "retrieveStatusMessage": "string",
- "archiveReturnMessage": { },
- "retrieveReturnMessage": { },
- "exportedTo": "string",
- "retrieveIntegrityCheck": true,
- "id": "string"
}, - "history": [
- {
- "id": "string"
}
], - "instrumentId": "string",
- "techniques": [
- {
- "pid": "string",
- "name": "string"
}
]
}
]Model instance data
| principalInvestigator required | string Email of principal investigator |
| endTime | string <date-time> Time of end of data taking for this dataset, format according to chapter 5.6 internet date/time format in RFC 3339. Local times without timezone/offset info are automatically transformed to UTC using the timezone of the API server |
| creationLocation required | string Unique location identifier where data was taken, usually in the form /Site-name/facility-name/instrumentOrBeamline-name |
| dataFormat | string Defines format of subsequent scientific meta data, e.g Nexus Version x.y |
| scientificMetadata | object JSON object containing the scientific meta data |
| pid required | string Persistent Identifier for datasets derived from UUIDv4 and prepended automatically by site specific PID prefix like 20.500.12345/ |
| owner required | string Owner of the data set, usually first name + lastname |
| ownerEmail | string Email of owner of the data set |
| orcidOfOwner | string ORCID of owner https://orcid.org if available |
| contactEmail required | string Email of contact person for this dataset |
| sourceFolder required | string Absolute file path on file server containing the files of this dataset, e.g. /some/path/to/sourcefolder. In case of a single file dataset, e.g. HDF5 data, it contains the path up to, but excluding the filename. Trailing slashes are removed. |
| sourceFolderHost | string DNS host name of file server hosting sourceFolder, optionally including protocol e.g. [protocol://]fileserver1.example.com |
| size | number <double> Total size of all source files contained in source folder on disk when unpacked |
| packedSize | number <double> Total size of all datablock package files created for this dataset |
| numberOfFiles | number <double> Total number of lines in filelisting of all OrigDatablocks for this dataset |
| numberOfFilesArchived | number <double> Total number of lines in filelisting of all Datablocks for this dataset |
| creationTime required | string <date-time> Time when dataset became fully available on disk, i.e. all containing files have been written. Format according to chapter 5.6 internet date/time format in RFC 3339. Local times without timezone/offset info are automatically transformed to UTC using the timezone of the API server. |
| type required | string Characterize type of dataset, either 'base' or 'raw' or 'derived'. Autofilled when choosing the proper inherited models |
| validationStatus | string Defines a level of trust, e.g. a measure of how much data was verified or used by other persons |
| keywords | Array of strings Array of tags associated with the meaning or contents of this dataset. Values should ideally come from defined vocabularies, taxonomies, ontologies or knowledge graphs |
| description | string Free text explanation of contents of dataset |
| datasetName | string A name for the dataset, given by the creator to carry some semantic meaning. Useful for display purposes e.g. instead of displaying the pid. Will be autofilled if missing using info from sourceFolder |
| classification | string ACIA information about AUthenticity,COnfidentiality,INtegrity and AVailability requirements of dataset. E.g. AV(ailabilty)=medium could trigger the creation of a two tape copies. Format 'AV=medium,CO=low' |
| license | string Name of license under which data can be used |
| version | string Version of API used in creation of dataset |
| isPublished | boolean Flag is true when data are made publically available |
| ownerGroup required | string Defines the group which owns the data, and therefore has unrestricted access to this data. Usually a pgroup like p12151 |
| accessGroups | Array of strings Optional additional groups which have read access to the data. Users which are member in one of the groups listed here are allowed to access this data. The special group 'public' makes data available to all users |
| createdBy | string Functional or user account name who created this instance |
| updatedBy | string Functional or user account name who last updated this instance |
| createdAt | string <date-time> |
| updatedAt | string <date-time> |
| sampleId | string |
| proposalId | string |
| publisheddataId | string |
object (DatasetLifecycle) For each dataset there exists an embedded dataset lifecycle document which describes the current status of the dataset during its lifetime with respect to the storage handling systems | |
Array of objects (Message) | |
| instrumentId | string |
Array of objects (Technique) |
{- "principalInvestigator": "string",
- "endTime": "2019-08-24T14:15:22Z",
- "creationLocation": "string",
- "dataFormat": "string",
- "scientificMetadata": { },
- "pid": "string",
- "owner": "string",
- "ownerEmail": "string",
- "orcidOfOwner": "string",
- "contactEmail": "string",
- "sourceFolder": "string",
- "sourceFolderHost": "string",
- "size": 0,
- "packedSize": 0,
- "numberOfFiles": 0,
- "numberOfFilesArchived": 0,
- "creationTime": "2019-08-24T14:15:22Z",
- "type": "string",
- "validationStatus": "string",
- "keywords": [
- "string"
], - "description": "string",
- "datasetName": "string",
- "classification": "string",
- "license": "string",
- "version": "string",
- "isPublished": true,
- "ownerGroup": "string",
- "accessGroups": [
- "string"
], - "createdBy": "string",
- "updatedBy": "string",
- "createdAt": "2019-08-24T14:15:22Z",
- "updatedAt": "2019-08-24T14:15:22Z",
- "sampleId": "string",
- "proposalId": "string",
- "publisheddataId": "string",
- "datasetlifecycle": {
- "archivable": true,
- "retrievable": true,
- "publishable": true,
- "dateOfDiskPurging": "2019-08-24T14:15:22Z",
- "archiveRetentionTime": "2019-08-24T14:15:22Z",
- "dateOfPublishing": "2019-08-24T14:15:22Z",
- "isOnCentralDisk": true,
- "archiveStatusMessage": "string",
- "retrieveStatusMessage": "string",
- "archiveReturnMessage": { },
- "retrieveReturnMessage": { },
- "exportedTo": "string",
- "retrieveIntegrityCheck": true,
- "id": "string"
}, - "history": [
- {
- "id": "string"
}
], - "instrumentId": "string",
- "techniques": [
- {
- "pid": "string",
- "name": "string"
}
]
}{- "principalInvestigator": "string",
- "endTime": "2019-08-24T14:15:22Z",
- "creationLocation": "string",
- "dataFormat": "string",
- "scientificMetadata": { },
- "pid": "string",
- "owner": "string",
- "ownerEmail": "string",
- "orcidOfOwner": "string",
- "contactEmail": "string",
- "sourceFolder": "string",
- "sourceFolderHost": "string",
- "size": 0,
- "packedSize": 0,
- "numberOfFiles": 0,
- "numberOfFilesArchived": 0,
- "creationTime": "2019-08-24T14:15:22Z",
- "type": "string",
- "validationStatus": "string",
- "keywords": [
- "string"
], - "description": "string",
- "datasetName": "string",
- "classification": "string",
- "license": "string",
- "version": "string",
- "isPublished": true,
- "ownerGroup": "string",
- "accessGroups": [
- "string"
], - "createdBy": "string",
- "updatedBy": "string",
- "createdAt": "2019-08-24T14:15:22Z",
- "updatedAt": "2019-08-24T14:15:22Z",
- "sampleId": "string",
- "proposalId": "string",
- "publisheddataId": "string",
- "datasetlifecycle": {
- "archivable": true,
- "retrievable": true,
- "publishable": true,
- "dateOfDiskPurging": "2019-08-24T14:15:22Z",
- "archiveRetentionTime": "2019-08-24T14:15:22Z",
- "dateOfPublishing": "2019-08-24T14:15:22Z",
- "isOnCentralDisk": true,
- "archiveStatusMessage": "string",
- "retrieveStatusMessage": "string",
- "archiveReturnMessage": { },
- "retrieveReturnMessage": { },
- "exportedTo": "string",
- "retrieveIntegrityCheck": true,
- "id": "string"
}, - "history": [
- {
- "id": "string"
}
], - "instrumentId": "string",
- "techniques": [
- {
- "pid": "string",
- "name": "string"
}
]
}| where | string <JSON> Criteria to match model instances |
An object of model property name/value pairs
| principalInvestigator required | string Email of principal investigator |
| endTime | string <date-time> Time of end of data taking for this dataset, format according to chapter 5.6 internet date/time format in RFC 3339. Local times without timezone/offset info are automatically transformed to UTC using the timezone of the API server |
| creationLocation required | string Unique location identifier where data was taken, usually in the form /Site-name/facility-name/instrumentOrBeamline-name |
| dataFormat | string Defines format of subsequent scientific meta data, e.g Nexus Version x.y |
| scientificMetadata | object JSON object containing the scientific meta data |
| pid required | string Persistent Identifier for datasets derived from UUIDv4 and prepended automatically by site specific PID prefix like 20.500.12345/ |
| owner required | string Owner of the data set, usually first name + lastname |
| ownerEmail | string Email of owner of the data set |
| orcidOfOwner | string ORCID of owner https://orcid.org if available |
| contactEmail required | string Email of contact person for this dataset |
| sourceFolder required | string Absolute file path on file server containing the files of this dataset, e.g. /some/path/to/sourcefolder. In case of a single file dataset, e.g. HDF5 data, it contains the path up to, but excluding the filename. Trailing slashes are removed. |
| sourceFolderHost | string DNS host name of file server hosting sourceFolder, optionally including protocol e.g. [protocol://]fileserver1.example.com |
| size | number <double> Total size of all source files contained in source folder on disk when unpacked |
| packedSize | number <double> Total size of all datablock package files created for this dataset |
| numberOfFiles | number <double> Total number of lines in filelisting of all OrigDatablocks for this dataset |
| numberOfFilesArchived | number <double> Total number of lines in filelisting of all Datablocks for this dataset |
| creationTime required | string <date-time> Time when dataset became fully available on disk, i.e. all containing files have been written. Format according to chapter 5.6 internet date/time format in RFC 3339. Local times without timezone/offset info are automatically transformed to UTC using the timezone of the API server. |
| type required | string Characterize type of dataset, either 'base' or 'raw' or 'derived'. Autofilled when choosing the proper inherited models |
| validationStatus | string Defines a level of trust, e.g. a measure of how much data was verified or used by other persons |
| keywords | Array of strings Array of tags associated with the meaning or contents of this dataset. Values should ideally come from defined vocabularies, taxonomies, ontologies or knowledge graphs |
| description | string Free text explanation of contents of dataset |
| datasetName | string A name for the dataset, given by the creator to carry some semantic meaning. Useful for display purposes e.g. instead of displaying the pid. Will be autofilled if missing using info from sourceFolder |
| classification | string ACIA information about AUthenticity,COnfidentiality,INtegrity and AVailability requirements of dataset. E.g. AV(ailabilty)=medium could trigger the creation of a two tape copies. Format 'AV=medium,CO=low' |
| license | string Name of license under which data can be used |
| version | string Version of API used in creation of dataset |
| isPublished | boolean Flag is true when data are made publically available |
| ownerGroup required | string Defines the group which owns the data, and therefore has unrestricted access to this data. Usually a pgroup like p12151 |
| accessGroups | Array of strings Optional additional groups which have read access to the data. Users which are member in one of the groups listed here are allowed to access this data. The special group 'public' makes data available to all users |
| createdBy | string Functional or user account name who created this instance |
| updatedBy | string Functional or user account name who last updated this instance |
| createdAt | string <date-time> |
| updatedAt | string <date-time> |
| sampleId | string |
| proposalId | string |
| publisheddataId | string |
object (DatasetLifecycle) For each dataset there exists an embedded dataset lifecycle document which describes the current status of the dataset during its lifetime with respect to the storage handling systems | |
Array of objects (Message) | |
| instrumentId | string |
Array of objects (Technique) |
{- "principalInvestigator": "string",
- "endTime": "2019-08-24T14:15:22Z",
- "creationLocation": "string",
- "dataFormat": "string",
- "scientificMetadata": { },
- "pid": "string",
- "owner": "string",
- "ownerEmail": "string",
- "orcidOfOwner": "string",
- "contactEmail": "string",
- "sourceFolder": "string",
- "sourceFolderHost": "string",
- "size": 0,
- "packedSize": 0,
- "numberOfFiles": 0,
- "numberOfFilesArchived": 0,
- "creationTime": "2019-08-24T14:15:22Z",
- "type": "string",
- "validationStatus": "string",
- "keywords": [
- "string"
], - "description": "string",
- "datasetName": "string",
- "classification": "string",
- "license": "string",
- "version": "string",
- "isPublished": true,
- "ownerGroup": "string",
- "accessGroups": [
- "string"
], - "createdBy": "string",
- "updatedBy": "string",
- "createdAt": "2019-08-24T14:15:22Z",
- "updatedAt": "2019-08-24T14:15:22Z",
- "sampleId": "string",
- "proposalId": "string",
- "publisheddataId": "string",
- "datasetlifecycle": {
- "archivable": true,
- "retrievable": true,
- "publishable": true,
- "dateOfDiskPurging": "2019-08-24T14:15:22Z",
- "archiveRetentionTime": "2019-08-24T14:15:22Z",
- "dateOfPublishing": "2019-08-24T14:15:22Z",
- "isOnCentralDisk": true,
- "archiveStatusMessage": "string",
- "retrieveStatusMessage": "string",
- "archiveReturnMessage": { },
- "retrieveReturnMessage": { },
- "exportedTo": "string",
- "retrieveIntegrityCheck": true,
- "id": "string"
}, - "history": [
- {
- "id": "string"
}
], - "instrumentId": "string",
- "techniques": [
- {
- "pid": "string",
- "name": "string"
}
]
}{- "principalInvestigator": "string",
- "endTime": "2019-08-24T14:15:22Z",
- "creationLocation": "string",
- "dataFormat": "string",
- "scientificMetadata": { },
- "pid": "string",
- "owner": "string",
- "ownerEmail": "string",
- "orcidOfOwner": "string",
- "contactEmail": "string",
- "sourceFolder": "string",
- "sourceFolderHost": "string",
- "size": 0,
- "packedSize": 0,
- "numberOfFiles": 0,
- "numberOfFilesArchived": 0,
- "creationTime": "2019-08-24T14:15:22Z",
- "type": "string",
- "validationStatus": "string",
- "keywords": [
- "string"
], - "description": "string",
- "datasetName": "string",
- "classification": "string",
- "license": "string",
- "version": "string",
- "isPublished": true,
- "ownerGroup": "string",
- "accessGroups": [
- "string"
], - "createdBy": "string",
- "updatedBy": "string",
- "createdAt": "2019-08-24T14:15:22Z",
- "updatedAt": "2019-08-24T14:15:22Z",
- "sampleId": "string",
- "proposalId": "string",
- "publisheddataId": "string",
- "datasetlifecycle": {
- "archivable": true,
- "retrievable": true,
- "publishable": true,
- "dateOfDiskPurging": "2019-08-24T14:15:22Z",
- "archiveRetentionTime": "2019-08-24T14:15:22Z",
- "dateOfPublishing": "2019-08-24T14:15:22Z",
- "isOnCentralDisk": true,
- "archiveStatusMessage": "string",
- "retrieveStatusMessage": "string",
- "archiveReturnMessage": { },
- "retrieveReturnMessage": { },
- "exportedTo": "string",
- "retrieveIntegrityCheck": true,
- "id": "string"
}, - "history": [
- {
- "id": "string"
}
], - "instrumentId": "string",
- "techniques": [
- {
- "pid": "string",
- "name": "string"
}
]
}| id required | string <JSON> Model id |
| filter | string <JSON> Filter defining fields and include - must be a JSON-encoded string ({"something":"value"}) |
{- "principalInvestigator": "string",
- "endTime": "2019-08-24T14:15:22Z",
- "creationLocation": "string",
- "dataFormat": "string",
- "scientificMetadata": { },
- "pid": "string",
- "owner": "string",
- "ownerEmail": "string",
- "orcidOfOwner": "string",
- "contactEmail": "string",
- "sourceFolder": "string",
- "sourceFolderHost": "string",
- "size": 0,
- "packedSize": 0,
- "numberOfFiles": 0,
- "numberOfFilesArchived": 0,
- "creationTime": "2019-08-24T14:15:22Z",
- "type": "string",
- "validationStatus": "string",
- "keywords": [
- "string"
], - "description": "string",
- "datasetName": "string",
- "classification": "string",
- "license": "string",
- "version": "string",
- "isPublished": true,
- "ownerGroup": "string",
- "accessGroups": [
- "string"
], - "createdBy": "string",
- "updatedBy": "string",
- "createdAt": "2019-08-24T14:15:22Z",
- "updatedAt": "2019-08-24T14:15:22Z",
- "sampleId": "string",
- "proposalId": "string",
- "publisheddataId": "string",
- "datasetlifecycle": {
- "archivable": true,
- "retrievable": true,
- "publishable": true,
- "dateOfDiskPurging": "2019-08-24T14:15:22Z",
- "archiveRetentionTime": "2019-08-24T14:15:22Z",
- "dateOfPublishing": "2019-08-24T14:15:22Z",
- "isOnCentralDisk": true,
- "archiveStatusMessage": "string",
- "retrieveStatusMessage": "string",
- "archiveReturnMessage": { },
- "retrieveReturnMessage": { },
- "exportedTo": "string",
- "retrieveIntegrityCheck": true,
- "id": "string"
}, - "history": [
- {
- "id": "string"
}
], - "instrumentId": "string",
- "techniques": [
- {
- "pid": "string",
- "name": "string"
}
]
}| id required | string <JSON> RawDataset id |
An object of model property name/value pairs
| principalInvestigator required | string Email of principal investigator |
| endTime | string <date-time> Time of end of data taking for this dataset, format according to chapter 5.6 internet date/time format in RFC 3339. Local times without timezone/offset info are automatically transformed to UTC using the timezone of the API server |
| creationLocation required | string Unique location identifier where data was taken, usually in the form /Site-name/facility-name/instrumentOrBeamline-name |
| dataFormat | string Defines format of subsequent scientific meta data, e.g Nexus Version x.y |
| scientificMetadata | object JSON object containing the scientific meta data |
| pid required | string Persistent Identifier for datasets derived from UUIDv4 and prepended automatically by site specific PID prefix like 20.500.12345/ |
| owner required | string Owner of the data set, usually first name + lastname |
| ownerEmail | string Email of owner of the data set |
| orcidOfOwner | string ORCID of owner https://orcid.org if available |
| contactEmail required | string Email of contact person for this dataset |
| sourceFolder required | string Absolute file path on file server containing the files of this dataset, e.g. /some/path/to/sourcefolder. In case of a single file dataset, e.g. HDF5 data, it contains the path up to, but excluding the filename. Trailing slashes are removed. |
| sourceFolderHost | string DNS host name of file server hosting sourceFolder, optionally including protocol e.g. [protocol://]fileserver1.example.com |
| size | number <double> Total size of all source files contained in source folder on disk when unpacked |
| packedSize | number <double> Total size of all datablock package files created for this dataset |
| numberOfFiles | number <double> Total number of lines in filelisting of all OrigDatablocks for this dataset |
| numberOfFilesArchived | number <double> Total number of lines in filelisting of all Datablocks for this dataset |
| creationTime required | string <date-time> Time when dataset became fully available on disk, i.e. all containing files have been written. Format according to chapter 5.6 internet date/time format in RFC 3339. Local times without timezone/offset info are automatically transformed to UTC using the timezone of the API server. |
| type required | string Characterize type of dataset, either 'base' or 'raw' or 'derived'. Autofilled when choosing the proper inherited models |
| validationStatus | string Defines a level of trust, e.g. a measure of how much data was verified or used by other persons |
| keywords | Array of strings Array of tags associated with the meaning or contents of this dataset. Values should ideally come from defined vocabularies, taxonomies, ontologies or knowledge graphs |
| description | string Free text explanation of contents of dataset |
| datasetName | string A name for the dataset, given by the creator to carry some semantic meaning. Useful for display purposes e.g. instead of displaying the pid. Will be autofilled if missing using info from sourceFolder |
| classification | string ACIA information about AUthenticity,COnfidentiality,INtegrity and AVailability requirements of dataset. E.g. AV(ailabilty)=medium could trigger the creation of a two tape copies. Format 'AV=medium,CO=low' |
| license | string Name of license under which data can be used |
| version | string Version of API used in creation of dataset |
| isPublished | boolean Flag is true when data are made publically available |
| ownerGroup required | string Defines the group which owns the data, and therefore has unrestricted access to this data. Usually a pgroup like p12151 |
| accessGroups | Array of strings Optional additional groups which have read access to the data. Users which are member in one of the groups listed here are allowed to access this data. The special group 'public' makes data available to all users |
| createdBy | string Functional or user account name who created this instance |
| updatedBy | string Functional or user account name who last updated this instance |
| createdAt | string <date-time> |
| updatedAt | string <date-time> |
| sampleId | string |
| proposalId | string |
| publisheddataId | string |
object (DatasetLifecycle) For each dataset there exists an embedded dataset lifecycle document which describes the current status of the dataset during its lifetime with respect to the storage handling systems | |
Array of objects (Message) | |
| instrumentId | string |
Array of objects (Technique) |
{- "principalInvestigator": "string",
- "endTime": "2019-08-24T14:15:22Z",
- "creationLocation": "string",
- "dataFormat": "string",
- "scientificMetadata": { },
- "pid": "string",
- "owner": "string",
- "ownerEmail": "string",
- "orcidOfOwner": "string",
- "contactEmail": "string",
- "sourceFolder": "string",
- "sourceFolderHost": "string",
- "size": 0,
- "packedSize": 0,
- "numberOfFiles": 0,
- "numberOfFilesArchived": 0,
- "creationTime": "2019-08-24T14:15:22Z",
- "type": "string",
- "validationStatus": "string",
- "keywords": [
- "string"
], - "description": "string",
- "datasetName": "string",
- "classification": "string",
- "license": "string",
- "version": "string",
- "isPublished": true,
- "ownerGroup": "string",
- "accessGroups": [
- "string"
], - "createdBy": "string",
- "updatedBy": "string",
- "createdAt": "2019-08-24T14:15:22Z",
- "updatedAt": "2019-08-24T14:15:22Z",
- "sampleId": "string",
- "proposalId": "string",
- "publisheddataId": "string",
- "datasetlifecycle": {
- "archivable": true,
- "retrievable": true,
- "publishable": true,
- "dateOfDiskPurging": "2019-08-24T14:15:22Z",
- "archiveRetentionTime": "2019-08-24T14:15:22Z",
- "dateOfPublishing": "2019-08-24T14:15:22Z",
- "isOnCentralDisk": true,
- "archiveStatusMessage": "string",
- "retrieveStatusMessage": "string",
- "archiveReturnMessage": { },
- "retrieveReturnMessage": { },
- "exportedTo": "string",
- "retrieveIntegrityCheck": true,
- "id": "string"
}, - "history": [
- {
- "id": "string"
}
], - "instrumentId": "string",
- "techniques": [
- {
- "pid": "string",
- "name": "string"
}
]
}{- "principalInvestigator": "string",
- "endTime": "2019-08-24T14:15:22Z",
- "creationLocation": "string",
- "dataFormat": "string",
- "scientificMetadata": { },
- "pid": "string",
- "owner": "string",
- "ownerEmail": "string",
- "orcidOfOwner": "string",
- "contactEmail": "string",
- "sourceFolder": "string",
- "sourceFolderHost": "string",
- "size": 0,
- "packedSize": 0,
- "numberOfFiles": 0,
- "numberOfFilesArchived": 0,
- "creationTime": "2019-08-24T14:15:22Z",
- "type": "string",
- "validationStatus": "string",
- "keywords": [
- "string"
], - "description": "string",
- "datasetName": "string",
- "classification": "string",
- "license": "string",
- "version": "string",
- "isPublished": true,
- "ownerGroup": "string",
- "accessGroups": [
- "string"
], - "createdBy": "string",
- "updatedBy": "string",
- "createdAt": "2019-08-24T14:15:22Z",
- "updatedAt": "2019-08-24T14:15:22Z",
- "sampleId": "string",
- "proposalId": "string",
- "publisheddataId": "string",
- "datasetlifecycle": {
- "archivable": true,
- "retrievable": true,
- "publishable": true,
- "dateOfDiskPurging": "2019-08-24T14:15:22Z",
- "archiveRetentionTime": "2019-08-24T14:15:22Z",
- "dateOfPublishing": "2019-08-24T14:15:22Z",
- "isOnCentralDisk": true,
- "archiveStatusMessage": "string",
- "retrieveStatusMessage": "string",
- "archiveReturnMessage": { },
- "retrieveReturnMessage": { },
- "exportedTo": "string",
- "retrieveIntegrityCheck": true,
- "id": "string"
}, - "history": [
- {
- "id": "string"
}
], - "instrumentId": "string",
- "techniques": [
- {
- "pid": "string",
- "name": "string"
}
]
}| id required | string <JSON> RawDataset id |
An object of model property name/value pairs
| principalInvestigator required | string Email of principal investigator |
| endTime | string <date-time> Time of end of data taking for this dataset, format according to chapter 5.6 internet date/time format in RFC 3339. Local times without timezone/offset info are automatically transformed to UTC using the timezone of the API server |
| creationLocation required | string Unique location identifier where data was taken, usually in the form /Site-name/facility-name/instrumentOrBeamline-name |
| dataFormat | string Defines format of subsequent scientific meta data, e.g Nexus Version x.y |
| scientificMetadata | object JSON object containing the scientific meta data |
| pid required | string Persistent Identifier for datasets derived from UUIDv4 and prepended automatically by site specific PID prefix like 20.500.12345/ |
| owner required | string Owner of the data set, usually first name + lastname |
| ownerEmail | string Email of owner of the data set |
| orcidOfOwner | string ORCID of owner https://orcid.org if available |
| contactEmail required | string Email of contact person for this dataset |
| sourceFolder required | string Absolute file path on file server containing the files of this dataset, e.g. /some/path/to/sourcefolder. In case of a single file dataset, e.g. HDF5 data, it contains the path up to, but excluding the filename. Trailing slashes are removed. |
| sourceFolderHost | string DNS host name of file server hosting sourceFolder, optionally including protocol e.g. [protocol://]fileserver1.example.com |
| size | number <double> Total size of all source files contained in source folder on disk when unpacked |
| packedSize | number <double> Total size of all datablock package files created for this dataset |
| numberOfFiles | number <double> Total number of lines in filelisting of all OrigDatablocks for this dataset |
| numberOfFilesArchived | number <double> Total number of lines in filelisting of all Datablocks for this dataset |
| creationTime required | string <date-time> Time when dataset became fully available on disk, i.e. all containing files have been written. Format according to chapter 5.6 internet date/time format in RFC 3339. Local times without timezone/offset info are automatically transformed to UTC using the timezone of the API server. |
| type required | string Characterize type of dataset, either 'base' or 'raw' or 'derived'. Autofilled when choosing the proper inherited models |
| validationStatus | string Defines a level of trust, e.g. a measure of how much data was verified or used by other persons |
| keywords | Array of strings Array of tags associated with the meaning or contents of this dataset. Values should ideally come from defined vocabularies, taxonomies, ontologies or knowledge graphs |
| description | string Free text explanation of contents of dataset |
| datasetName | string A name for the dataset, given by the creator to carry some semantic meaning. Useful for display purposes e.g. instead of displaying the pid. Will be autofilled if missing using info from sourceFolder |
| classification | string ACIA information about AUthenticity,COnfidentiality,INtegrity and AVailability requirements of dataset. E.g. AV(ailabilty)=medium could trigger the creation of a two tape copies. Format 'AV=medium,CO=low' |
| license | string Name of license under which data can be used |
| version | string Version of API used in creation of dataset |
| isPublished | boolean Flag is true when data are made publically available |
| ownerGroup required | string Defines the group which owns the data, and therefore has unrestricted access to this data. Usually a pgroup like p12151 |
| accessGroups | Array of strings Optional additional groups which have read access to the data. Users which are member in one of the groups listed here are allowed to access this data. The special group 'public' makes data available to all users |
| createdBy | string Functional or user account name who created this instance |
| updatedBy | string Functional or user account name who last updated this instance |
| createdAt | string <date-time> |
| updatedAt | string <date-time> |
| sampleId | string |
| proposalId | string |
| publisheddataId | string |
object (DatasetLifecycle) For each dataset there exists an embedded dataset lifecycle document which describes the current status of the dataset during its lifetime with respect to the storage handling systems | |
Array of objects (Message) | |
| instrumentId | string |
Array of objects (Technique) |
{- "principalInvestigator": "string",
- "endTime": "2019-08-24T14:15:22Z",
- "creationLocation": "string",
- "dataFormat": "string",
- "scientificMetadata": { },
- "pid": "string",
- "owner": "string",
- "ownerEmail": "string",
- "orcidOfOwner": "string",
- "contactEmail": "string",
- "sourceFolder": "string",
- "sourceFolderHost": "string",
- "size": 0,
- "packedSize": 0,
- "numberOfFiles": 0,
- "numberOfFilesArchived": 0,
- "creationTime": "2019-08-24T14:15:22Z",
- "type": "string",
- "validationStatus": "string",
- "keywords": [
- "string"
], - "description": "string",
- "datasetName": "string",
- "classification": "string",
- "license": "string",
- "version": "string",
- "isPublished": true,
- "ownerGroup": "string",
- "accessGroups": [
- "string"
], - "createdBy": "string",
- "updatedBy": "string",
- "createdAt": "2019-08-24T14:15:22Z",
- "updatedAt": "2019-08-24T14:15:22Z",
- "sampleId": "string",
- "proposalId": "string",
- "publisheddataId": "string",
- "datasetlifecycle": {
- "archivable": true,
- "retrievable": true,
- "publishable": true,
- "dateOfDiskPurging": "2019-08-24T14:15:22Z",
- "archiveRetentionTime": "2019-08-24T14:15:22Z",
- "dateOfPublishing": "2019-08-24T14:15:22Z",
- "isOnCentralDisk": true,
- "archiveStatusMessage": "string",
- "retrieveStatusMessage": "string",
- "archiveReturnMessage": { },
- "retrieveReturnMessage": { },
- "exportedTo": "string",
- "retrieveIntegrityCheck": true,
- "id": "string"
}, - "history": [
- {
- "id": "string"
}
], - "instrumentId": "string",
- "techniques": [
- {
- "pid": "string",
- "name": "string"
}
]
}{- "principalInvestigator": "string",
- "endTime": "2019-08-24T14:15:22Z",
- "creationLocation": "string",
- "dataFormat": "string",
- "scientificMetadata": { },
- "pid": "string",
- "owner": "string",
- "ownerEmail": "string",
- "orcidOfOwner": "string",
- "contactEmail": "string",
- "sourceFolder": "string",
- "sourceFolderHost": "string",
- "size": 0,
- "packedSize": 0,
- "numberOfFiles": 0,
- "numberOfFilesArchived": 0,
- "creationTime": "2019-08-24T14:15:22Z",
- "type": "string",
- "validationStatus": "string",
- "keywords": [
- "string"
], - "description": "string",
- "datasetName": "string",
- "classification": "string",
- "license": "string",
- "version": "string",
- "isPublished": true,
- "ownerGroup": "string",
- "accessGroups": [
- "string"
], - "createdBy": "string",
- "updatedBy": "string",
- "createdAt": "2019-08-24T14:15:22Z",
- "updatedAt": "2019-08-24T14:15:22Z",
- "sampleId": "string",
- "proposalId": "string",
- "publisheddataId": "string",
- "datasetlifecycle": {
- "archivable": true,
- "retrievable": true,
- "publishable": true,
- "dateOfDiskPurging": "2019-08-24T14:15:22Z",
- "archiveRetentionTime": "2019-08-24T14:15:22Z",
- "dateOfPublishing": "2019-08-24T14:15:22Z",
- "isOnCentralDisk": true,
- "archiveStatusMessage": "string",
- "retrieveStatusMessage": "string",
- "archiveReturnMessage": { },
- "retrieveReturnMessage": { },
- "exportedTo": "string",
- "retrieveIntegrityCheck": true,
- "id": "string"
}, - "history": [
- {
- "id": "string"
}
], - "instrumentId": "string",
- "techniques": [
- {
- "pid": "string",
- "name": "string"
}
]
}| id required | string <JSON> Model id |
Model instance data
| principalInvestigator required | string Email of principal investigator |
| endTime | string <date-time> Time of end of data taking for this dataset, format according to chapter 5.6 internet date/time format in RFC 3339. Local times without timezone/offset info are automatically transformed to UTC using the timezone of the API server |
| creationLocation required | string Unique location identifier where data was taken, usually in the form /Site-name/facility-name/instrumentOrBeamline-name |
| dataFormat | string Defines format of subsequent scientific meta data, e.g Nexus Version x.y |
| scientificMetadata | object JSON object containing the scientific meta data |
| pid required | string Persistent Identifier for datasets derived from UUIDv4 and prepended automatically by site specific PID prefix like 20.500.12345/ |
| owner required | string Owner of the data set, usually first name + lastname |
| ownerEmail | string Email of owner of the data set |
| orcidOfOwner | string ORCID of owner https://orcid.org if available |
| contactEmail required | string Email of contact person for this dataset |
| sourceFolder required | string Absolute file path on file server containing the files of this dataset, e.g. /some/path/to/sourcefolder. In case of a single file dataset, e.g. HDF5 data, it contains the path up to, but excluding the filename. Trailing slashes are removed. |
| sourceFolderHost | string DNS host name of file server hosting sourceFolder, optionally including protocol e.g. [protocol://]fileserver1.example.com |
| size | number <double> Total size of all source files contained in source folder on disk when unpacked |
| packedSize | number <double> Total size of all datablock package files created for this dataset |
| numberOfFiles | number <double> Total number of lines in filelisting of all OrigDatablocks for this dataset |
| numberOfFilesArchived | number <double> Total number of lines in filelisting of all Datablocks for this dataset |
| creationTime required | string <date-time> Time when dataset became fully available on disk, i.e. all containing files have been written. Format according to chapter 5.6 internet date/time format in RFC 3339. Local times without timezone/offset info are automatically transformed to UTC using the timezone of the API server. |
| type required | string Characterize type of dataset, either 'base' or 'raw' or 'derived'. Autofilled when choosing the proper inherited models |
| validationStatus | string Defines a level of trust, e.g. a measure of how much data was verified or used by other persons |
| keywords | Array of strings Array of tags associated with the meaning or contents of this dataset. Values should ideally come from defined vocabularies, taxonomies, ontologies or knowledge graphs |
| description | string Free text explanation of contents of dataset |
| datasetName | string A name for the dataset, given by the creator to carry some semantic meaning. Useful for display purposes e.g. instead of displaying the pid. Will be autofilled if missing using info from sourceFolder |
| classification | string ACIA information about AUthenticity,COnfidentiality,INtegrity and AVailability requirements of dataset. E.g. AV(ailabilty)=medium could trigger the creation of a two tape copies. Format 'AV=medium,CO=low' |
| license | string Name of license under which data can be used |
| version | string Version of API used in creation of dataset |
| isPublished | boolean Flag is true when data are made publically available |
| ownerGroup required | string Defines the group which owns the data, and therefore has unrestricted access to this data. Usually a pgroup like p12151 |
| accessGroups | Array of strings Optional additional groups which have read access to the data. Users which are member in one of the groups listed here are allowed to access this data. The special group 'public' makes data available to all users |
| createdBy | string Functional or user account name who created this instance |
| updatedBy | string Functional or user account name who last updated this instance |
| createdAt | string <date-time> |
| updatedAt | string <date-time> |
| sampleId | string |
| proposalId | string |
| publisheddataId | string |
object (DatasetLifecycle) For each dataset there exists an embedded dataset lifecycle document which describes the current status of the dataset during its lifetime with respect to the storage handling systems | |
Array of objects (Message) | |
| instrumentId | string |
Array of objects (Technique) |
{- "principalInvestigator": "string",
- "endTime": "2019-08-24T14:15:22Z",
- "creationLocation": "string",
- "dataFormat": "string",
- "scientificMetadata": { },
- "pid": "string",
- "owner": "string",
- "ownerEmail": "string",
- "orcidOfOwner": "string",
- "contactEmail": "string",
- "sourceFolder": "string",
- "sourceFolderHost": "string",
- "size": 0,
- "packedSize": 0,
- "numberOfFiles": 0,
- "numberOfFilesArchived": 0,
- "creationTime": "2019-08-24T14:15:22Z",
- "type": "string",
- "validationStatus": "string",
- "keywords": [
- "string"
], - "description": "string",
- "datasetName": "string",
- "classification": "string",
- "license": "string",
- "version": "string",
- "isPublished": true,
- "ownerGroup": "string",
- "accessGroups": [
- "string"
], - "createdBy": "string",
- "updatedBy": "string",
- "createdAt": "2019-08-24T14:15:22Z",
- "updatedAt": "2019-08-24T14:15:22Z",
- "sampleId": "string",
- "proposalId": "string",
- "publisheddataId": "string",
- "datasetlifecycle": {
- "archivable": true,
- "retrievable": true,
- "publishable": true,
- "dateOfDiskPurging": "2019-08-24T14:15:22Z",
- "archiveRetentionTime": "2019-08-24T14:15:22Z",
- "dateOfPublishing": "2019-08-24T14:15:22Z",
- "isOnCentralDisk": true,
- "archiveStatusMessage": "string",
- "retrieveStatusMessage": "string",
- "archiveReturnMessage": { },
- "retrieveReturnMessage": { },
- "exportedTo": "string",
- "retrieveIntegrityCheck": true,
- "id": "string"
}, - "history": [
- {
- "id": "string"
}
], - "instrumentId": "string",
- "techniques": [
- {
- "pid": "string",
- "name": "string"
}
]
}{- "principalInvestigator": "string",
- "endTime": "2019-08-24T14:15:22Z",
- "creationLocation": "string",
- "dataFormat": "string",
- "scientificMetadata": { },
- "pid": "string",
- "owner": "string",
- "ownerEmail": "string",
- "orcidOfOwner": "string",
- "contactEmail": "string",
- "sourceFolder": "string",
- "sourceFolderHost": "string",
- "size": 0,
- "packedSize": 0,
- "numberOfFiles": 0,
- "numberOfFilesArchived": 0,
- "creationTime": "2019-08-24T14:15:22Z",
- "type": "string",
- "validationStatus": "string",
- "keywords": [
- "string"
], - "description": "string",
- "datasetName": "string",
- "classification": "string",
- "license": "string",
- "version": "string",
- "isPublished": true,
- "ownerGroup": "string",
- "accessGroups": [
- "string"
], - "createdBy": "string",
- "updatedBy": "string",
- "createdAt": "2019-08-24T14:15:22Z",
- "updatedAt": "2019-08-24T14:15:22Z",
- "sampleId": "string",
- "proposalId": "string",
- "publisheddataId": "string",
- "datasetlifecycle": {
- "archivable": true,
- "retrievable": true,
- "publishable": true,
- "dateOfDiskPurging": "2019-08-24T14:15:22Z",
- "archiveRetentionTime": "2019-08-24T14:15:22Z",
- "dateOfPublishing": "2019-08-24T14:15:22Z",
- "isOnCentralDisk": true,
- "archiveStatusMessage": "string",
- "retrieveStatusMessage": "string",
- "archiveReturnMessage": { },
- "retrieveReturnMessage": { },
- "exportedTo": "string",
- "retrieveIntegrityCheck": true,
- "id": "string"
}, - "history": [
- {
- "id": "string"
}
], - "instrumentId": "string",
- "techniques": [
- {
- "pid": "string",
- "name": "string"
}
]
}| filter | string <JSON> Filter defining fields, where, include, order, offset, and limit - must be a JSON-encoded string ( |
{- "principalInvestigator": "string",
- "endTime": "2019-08-24T14:15:22Z",
- "creationLocation": "string",
- "dataFormat": "string",
- "scientificMetadata": { },
- "pid": "string",
- "owner": "string",
- "ownerEmail": "string",
- "orcidOfOwner": "string",
- "contactEmail": "string",
- "sourceFolder": "string",
- "sourceFolderHost": "string",
- "size": 0,
- "packedSize": 0,
- "numberOfFiles": 0,
- "numberOfFilesArchived": 0,
- "creationTime": "2019-08-24T14:15:22Z",
- "type": "string",
- "validationStatus": "string",
- "keywords": [
- "string"
], - "description": "string",
- "datasetName": "string",
- "classification": "string",
- "license": "string",
- "version": "string",
- "isPublished": true,
- "ownerGroup": "string",
- "accessGroups": [
- "string"
], - "createdBy": "string",
- "updatedBy": "string",
- "createdAt": "2019-08-24T14:15:22Z",
- "updatedAt": "2019-08-24T14:15:22Z",
- "sampleId": "string",
- "proposalId": "string",
- "publisheddataId": "string",
- "datasetlifecycle": {
- "archivable": true,
- "retrievable": true,
- "publishable": true,
- "dateOfDiskPurging": "2019-08-24T14:15:22Z",
- "archiveRetentionTime": "2019-08-24T14:15:22Z",
- "dateOfPublishing": "2019-08-24T14:15:22Z",
- "isOnCentralDisk": true,
- "archiveStatusMessage": "string",
- "retrieveStatusMessage": "string",
- "archiveReturnMessage": { },
- "retrieveReturnMessage": { },
- "exportedTo": "string",
- "retrieveIntegrityCheck": true,
- "id": "string"
}, - "history": [
- {
- "id": "string"
}
], - "instrumentId": "string",
- "techniques": [
- {
- "pid": "string",
- "name": "string"
}
]
}| where | string <JSON> Criteria to match model instances |
An object of model property name/value pairs
| principalInvestigator required | string Email of principal investigator |
| endTime | string <date-time> Time of end of data taking for this dataset, format according to chapter 5.6 internet date/time format in RFC 3339. Local times without timezone/offset info are automatically transformed to UTC using the timezone of the API server |
| creationLocation required | string Unique location identifier where data was taken, usually in the form /Site-name/facility-name/instrumentOrBeamline-name |
| dataFormat | string Defines format of subsequent scientific meta data, e.g Nexus Version x.y |
| scientificMetadata | object JSON object containing the scientific meta data |
| pid required | string Persistent Identifier for datasets derived from UUIDv4 and prepended automatically by site specific PID prefix like 20.500.12345/ |
| owner required | string Owner of the data set, usually first name + lastname |
| ownerEmail | string Email of owner of the data set |
| orcidOfOwner | string ORCID of owner https://orcid.org if available |
| contactEmail required | string Email of contact person for this dataset |
| sourceFolder required | string Absolute file path on file server containing the files of this dataset, e.g. /some/path/to/sourcefolder. In case of a single file dataset, e.g. HDF5 data, it contains the path up to, but excluding the filename. Trailing slashes are removed. |
| sourceFolderHost | string DNS host name of file server hosting sourceFolder, optionally including protocol e.g. [protocol://]fileserver1.example.com |
| size | number <double> Total size of all source files contained in source folder on disk when unpacked |
| packedSize | number <double> Total size of all datablock package files created for this dataset |
| numberOfFiles | number <double> Total number of lines in filelisting of all OrigDatablocks for this dataset |
| numberOfFilesArchived | number <double> Total number of lines in filelisting of all Datablocks for this dataset |
| creationTime required | string <date-time> Time when dataset became fully available on disk, i.e. all containing files have been written. Format according to chapter 5.6 internet date/time format in RFC 3339. Local times without timezone/offset info are automatically transformed to UTC using the timezone of the API server. |
| type required | string Characterize type of dataset, either 'base' or 'raw' or 'derived'. Autofilled when choosing the proper inherited models |
| validationStatus | string Defines a level of trust, e.g. a measure of how much data was verified or used by other persons |
| keywords | Array of strings Array of tags associated with the meaning or contents of this dataset. Values should ideally come from defined vocabularies, taxonomies, ontologies or knowledge graphs |
| description | string Free text explanation of contents of dataset |
| datasetName | string A name for the dataset, given by the creator to carry some semantic meaning. Useful for display purposes e.g. instead of displaying the pid. Will be autofilled if missing using info from sourceFolder |
| classification | string ACIA information about AUthenticity,COnfidentiality,INtegrity and AVailability requirements of dataset. E.g. AV(ailabilty)=medium could trigger the creation of a two tape copies. Format 'AV=medium,CO=low' |
| license | string Name of license under which data can be used |
| version | string Version of API used in creation of dataset |
| isPublished | boolean Flag is true when data are made publically available |
| ownerGroup required | string Defines the group which owns the data, and therefore has unrestricted access to this data. Usually a pgroup like p12151 |
| accessGroups | Array of strings Optional additional groups which have read access to the data. Users which are member in one of the groups listed here are allowed to access this data. The special group 'public' makes data available to all users |
| createdBy | string Functional or user account name who created this instance |
| updatedBy | string Functional or user account name who last updated this instance |
| createdAt | string <date-time> |
| updatedAt | string <date-time> |
| sampleId | string |
| proposalId | string |
| publisheddataId | string |
object (DatasetLifecycle) For each dataset there exists an embedded dataset lifecycle document which describes the current status of the dataset during its lifetime with respect to the storage handling systems | |
Array of objects (Message) | |
| instrumentId | string |
Array of objects (Technique) |
{- "principalInvestigator": "string",
- "endTime": "2019-08-24T14:15:22Z",
- "creationLocation": "string",
- "dataFormat": "string",
- "scientificMetadata": { },
- "pid": "string",
- "owner": "string",
- "ownerEmail": "string",
- "orcidOfOwner": "string",
- "contactEmail": "string",
- "sourceFolder": "string",
- "sourceFolderHost": "string",
- "size": 0,
- "packedSize": 0,
- "numberOfFiles": 0,
- "numberOfFilesArchived": 0,
- "creationTime": "2019-08-24T14:15:22Z",
- "type": "string",
- "validationStatus": "string",
- "keywords": [
- "string"
], - "description": "string",
- "datasetName": "string",
- "classification": "string",
- "license": "string",
- "version": "string",
- "isPublished": true,
- "ownerGroup": "string",
- "accessGroups": [
- "string"
], - "createdBy": "string",
- "updatedBy": "string",
- "createdAt": "2019-08-24T14:15:22Z",
- "updatedAt": "2019-08-24T14:15:22Z",
- "sampleId": "string",
- "proposalId": "string",
- "publisheddataId": "string",
- "datasetlifecycle": {
- "archivable": true,
- "retrievable": true,
- "publishable": true,
- "dateOfDiskPurging": "2019-08-24T14:15:22Z",
- "archiveRetentionTime": "2019-08-24T14:15:22Z",
- "dateOfPublishing": "2019-08-24T14:15:22Z",
- "isOnCentralDisk": true,
- "archiveStatusMessage": "string",
- "retrieveStatusMessage": "string",
- "archiveReturnMessage": { },
- "retrieveReturnMessage": { },
- "exportedTo": "string",
- "retrieveIntegrityCheck": true,
- "id": "string"
}, - "history": [
- {
- "id": "string"
}
], - "instrumentId": "string",
- "techniques": [
- {
- "pid": "string",
- "name": "string"
}
]
}{- "count": 0
}{ }{ }| datasetId | string |
{ }| fields | string <JSON> Define the filter conditions by specifying the name and values of fields. There ia also support for a |
| facets | string <JSON> Defines list of field names, for which facet counts should be calculated |
{ }| fields | string <JSON> Define the filter conditions by specifying the name of values of fields requested. There ia also support for a |
| limits | string <JSON> Define further query parameters like skip, limit, order |
{ }| fields | string <JSON> Define the filter conditions by specifying the name of values of fields requested. There ia also support for a |
| limits | string <JSON> Define further query parameters like skip, limit, order |
{ }Contains the information for datasets which are the result of an analysis step, typically based on raw datasets or other derived datasets as input. Derived datasets are typically added by the researcher pursuing the specific analysis. This schema inherits the fields from the generic Dataset collection and adds specific fields as defined below.
| id required | string <JSON> DerivedDataset id |
| fk required | string <JSON> Foreign key for samples |
{- "sampleId": "string",
- "owner": "string",
- "description": "string",
- "createdAt": "2019-08-24T14:15:22Z",
- "sampleCharacteristics": { },
- "isPublished": true,
- "ownerGroup": "string",
- "accessGroups": [
- "string"
], - "createdBy": "string",
- "updatedBy": "string",
- "datasetsId": "string",
- "datasetId": "string",
- "rawDatasetId": "string",
- "derivedDatasetId": "string",
- "updatedAt": "2019-08-24T14:15:22Z"
}| id required | string <JSON> DerivedDataset id |
| fk required | string <JSON> Foreign key for samples |
| sampleId required | string |
| owner | string |
| description | string |
| createdAt | string <date-time> |
| sampleCharacteristics | object |
| isPublished | boolean Flag is true when data are made publically available |
| ownerGroup required | string Defines the group which owns the data, and therefore has unrestricted access to this data. Usually a pgroup like p12151 |
| accessGroups | Array of strings Optional additional groups which have read access to the data. Users which are member in one of the groups listed here are allowed to access this data. The special group 'public' makes data available to all users |
| createdBy | string Functional or user account name who created this instance |
| updatedBy | string Functional or user account name who last updated this instance |
| datasetsId | string |
| datasetId | string |
| rawDatasetId | string |
| derivedDatasetId | string |
| updatedAt | string <date-time> |
{- "sampleId": "string",
- "owner": "string",
- "description": "string",
- "createdAt": "2019-08-24T14:15:22Z",
- "sampleCharacteristics": { },
- "isPublished": true,
- "ownerGroup": "string",
- "accessGroups": [
- "string"
], - "createdBy": "string",
- "updatedBy": "string",
- "datasetsId": "string",
- "datasetId": "string",
- "rawDatasetId": "string",
- "derivedDatasetId": "string",
- "updatedAt": "2019-08-24T14:15:22Z"
}{- "sampleId": "string",
- "owner": "string",
- "description": "string",
- "createdAt": "2019-08-24T14:15:22Z",
- "sampleCharacteristics": { },
- "isPublished": true,
- "ownerGroup": "string",
- "accessGroups": [
- "string"
], - "createdBy": "string",
- "updatedBy": "string",
- "datasetsId": "string",
- "datasetId": "string",
- "rawDatasetId": "string",
- "derivedDatasetId": "string",
- "updatedAt": "2019-08-24T14:15:22Z"
}| id required | string <JSON> DerivedDataset id |
| refresh | boolean |
{- "doi": "string",
- "affiliation": "string",
- "creator": [
- "string"
], - "publisher": "string",
- "publicationYear": 0,
- "title": "string",
- "url": "string",
- "abstract": "string",
- "dataDescription": "string",
- "resourceType": "string",
- "numberOfFiles": 0,
- "sizeOfArchive": 0,
- "pidArray": [
- "string"
], - "authors": [
- "string"
], - "registeredTime": "2019-08-24T14:15:22Z",
- "status": "string",
- "scicatUser": "string",
- "thumbnail": "string",
- "relatedPublications": [
- "string"
], - "downloadLink": "string",
- "createdBy": "string",
- "updatedBy": "string",
- "createdAt": "2019-08-24T14:15:22Z",
- "updatedAt": "2019-08-24T14:15:22Z"
}| id required | string <JSON> DerivedDataset id |
| refresh | boolean |
{- "archivable": true,
- "retrievable": true,
- "publishable": true,
- "dateOfDiskPurging": "2019-08-24T14:15:22Z",
- "archiveRetentionTime": "2019-08-24T14:15:22Z",
- "dateOfPublishing": "2019-08-24T14:15:22Z",
- "isOnCentralDisk": true,
- "archiveStatusMessage": "string",
- "retrieveStatusMessage": "string",
- "archiveReturnMessage": { },
- "retrieveReturnMessage": { },
- "exportedTo": "string",
- "retrieveIntegrityCheck": true,
- "id": "string"
}| id required | string <JSON> DerivedDataset id |
| archivable | boolean Flag which is true, if dataset is available to be archived and no archive job for this dataset exists yet. |
| retrievable | boolean Flag which is true, if dataset is stored on archive system and is ready to be retrieved. |
| publishable | boolean Flag which is true, if dataset can be published. Usually requires a longterm storage option on tape or similar. |
| dateOfDiskPurging | string <date-time> Day when dataset will be removed from disk, assuming that is already stored on tape. |
| archiveRetentionTime | string <date-time> Day when the dataset's future fate will be evaluated again, e.g. to decide if the dataset can be deleted from archive. |
| dateOfPublishing | string <date-time> Day when dataset is supposed to become public according to data policy |
| isOnCentralDisk | boolean Flag which is true, if full dataset is available on central fileserver. If false data needs to be copied from decentral storage place to a cache server before the ingest. This information needs to be transferred to the archive system at archive time |
| archiveStatusMessage | string Short string defining current status of Dataset with respect to storage on disk/tape. |
| retrieveStatusMessage | string Latest message for this dataset concerning retrieve from archive system. |
| archiveReturnMessage | object Detailed status or error message returned by archive system when archiving this dataset. |
| retrieveReturnMessage | object Detailed status or error message returned by archive system when retrieving this dataset. |
| exportedTo | string Location of the last export destination. |
| retrieveIntegrityCheck | boolean Set to true when checksum tests after retrieve of datasets were successful |
| id | string |
{- "archivable": true,
- "retrievable": true,
- "publishable": true,
- "dateOfDiskPurging": "2019-08-24T14:15:22Z",
- "archiveRetentionTime": "2019-08-24T14:15:22Z",
- "dateOfPublishing": "2019-08-24T14:15:22Z",
- "isOnCentralDisk": true,
- "archiveStatusMessage": "string",
- "retrieveStatusMessage": "string",
- "archiveReturnMessage": { },
- "retrieveReturnMessage": { },
- "exportedTo": "string",
- "retrieveIntegrityCheck": true,
- "id": "string"
}{- "archivable": true,
- "retrievable": true,
- "publishable": true,
- "dateOfDiskPurging": "2019-08-24T14:15:22Z",
- "archiveRetentionTime": "2019-08-24T14:15:22Z",
- "dateOfPublishing": "2019-08-24T14:15:22Z",
- "isOnCentralDisk": true,
- "archiveStatusMessage": "string",
- "retrieveStatusMessage": "string",
- "archiveReturnMessage": { },
- "retrieveReturnMessage": { },
- "exportedTo": "string",
- "retrieveIntegrityCheck": true,
- "id": "string"
}| id required | string <JSON> DerivedDataset id |
| archivable | boolean Flag which is true, if dataset is available to be archived and no archive job for this dataset exists yet. |
| retrievable | boolean Flag which is true, if dataset is stored on archive system and is ready to be retrieved. |
| publishable | boolean Flag which is true, if dataset can be published. Usually requires a longterm storage option on tape or similar. |
| dateOfDiskPurging | string <date-time> Day when dataset will be removed from disk, assuming that is already stored on tape. |
| archiveRetentionTime | string <date-time> Day when the dataset's future fate will be evaluated again, e.g. to decide if the dataset can be deleted from archive. |
| dateOfPublishing | string <date-time> Day when dataset is supposed to become public according to data policy |
| isOnCentralDisk | boolean Flag which is true, if full dataset is available on central fileserver. If false data needs to be copied from decentral storage place to a cache server before the ingest. This information needs to be transferred to the archive system at archive time |
| archiveStatusMessage | string Short string defining current status of Dataset with respect to storage on disk/tape. |
| retrieveStatusMessage | string Latest message for this dataset concerning retrieve from archive system. |
| archiveReturnMessage | object Detailed status or error message returned by archive system when archiving this dataset. |
| retrieveReturnMessage | object Detailed status or error message returned by archive system when retrieving this dataset. |
| exportedTo | string Location of the last export destination. |
| retrieveIntegrityCheck | boolean Set to true when checksum tests after retrieve of datasets were successful |
| id | string |
{- "archivable": true,
- "retrievable": true,
- "publishable": true,
- "dateOfDiskPurging": "2019-08-24T14:15:22Z",
- "archiveRetentionTime": "2019-08-24T14:15:22Z",
- "dateOfPublishing": "2019-08-24T14:15:22Z",
- "isOnCentralDisk": true,
- "archiveStatusMessage": "string",
- "retrieveStatusMessage": "string",
- "archiveReturnMessage": { },
- "retrieveReturnMessage": { },
- "exportedTo": "string",
- "retrieveIntegrityCheck": true,
- "id": "string"
}{- "archivable": true,
- "retrievable": true,
- "publishable": true,
- "dateOfDiskPurging": "2019-08-24T14:15:22Z",
- "archiveRetentionTime": "2019-08-24T14:15:22Z",
- "dateOfPublishing": "2019-08-24T14:15:22Z",
- "isOnCentralDisk": true,
- "archiveStatusMessage": "string",
- "retrieveStatusMessage": "string",
- "archiveReturnMessage": { },
- "retrieveReturnMessage": { },
- "exportedTo": "string",
- "retrieveIntegrityCheck": true,
- "id": "string"
}| id required | string <JSON> DerivedDataset id |
| fk required | string <JSON> Foreign key for datablocks |
{- "id": "string",
- "archiveId": "string",
- "size": 0,
- "packedSize": 0,
- "chkAlg": "string",
- "version": "string",
- "dataFileList": [
- {
- "path": "string",
- "size": 0,
- "time": "2019-08-24T14:15:22Z",
- "chk": "string",
- "uid": "string",
- "gid": "string",
- "perm": "string"
}
], - "ownerGroup": "string",
- "accessGroups": [
- "string"
], - "createdBy": "string",
- "updatedBy": "string",
- "datasetId": "string",
- "rawDatasetId": "string",
- "derivedDatasetId": "string",
- "createdAt": "2019-08-24T14:15:22Z",
- "updatedAt": "2019-08-24T14:15:22Z"
}| id required | string <JSON> DerivedDataset id |
| fk required | string <JSON> Foreign key for datablocks |
| id required | string Catalog internal UUIDv4 for datablock |
| archiveId required | string Unique identifier given bey archive system to the stored datablock. This id is used when data is retrieved back. |
| size required | number <double> Total size in bytes of all files in datablock when unpacked |
| packedSize | number <double> Size of datablock package file |
| chkAlg | string Algoritm used for calculation of checksums, e.g. sha2 |
| version required | string Version string defining format of how data is packed and stored in archive |
required | Array of objects (Datafile) |
| ownerGroup required | string Defines the group which owns the data, and therefore has unrestricted access to this data. Usually a pgroup like p12151 |
| accessGroups | Array of strings Optional additional groups which have read access to the data. Users which are member in one of the groups listed here are allowed to access this data. The special group 'public' makes data available to all users |
| createdBy | string Functional or user account name who created this instance |
| updatedBy | string Functional or user account name who last updated this instance |
| datasetId | string |
| rawDatasetId | string |
| derivedDatasetId | string |
| createdAt | string <date-time> |
| updatedAt | string <date-time> |
{- "id": "string",
- "archiveId": "string",
- "size": 0,
- "packedSize": 0,
- "chkAlg": "string",
- "version": "string",
- "dataFileList": [
- {
- "path": "string",
- "size": 0,
- "time": "2019-08-24T14:15:22Z",
- "chk": "string",
- "uid": "string",
- "gid": "string",
- "perm": "string"
}
], - "ownerGroup": "string",
- "accessGroups": [
- "string"
], - "createdBy": "string",
- "updatedBy": "string",
- "datasetId": "string",
- "rawDatasetId": "string",
- "derivedDatasetId": "string",
- "createdAt": "2019-08-24T14:15:22Z",
- "updatedAt": "2019-08-24T14:15:22Z"
}{- "id": "string",
- "archiveId": "string",
- "size": 0,
- "packedSize": 0,
- "chkAlg": "string",
- "version": "string",
- "dataFileList": [
- {
- "path": "string",
- "size": 0,
- "time": "2019-08-24T14:15:22Z",
- "chk": "string",
- "uid": "string",
- "gid": "string",
- "perm": "string"
}
], - "ownerGroup": "string",
- "accessGroups": [
- "string"
], - "createdBy": "string",
- "updatedBy": "string",
- "datasetId": "string",
- "rawDatasetId": "string",
- "derivedDatasetId": "string",
- "createdAt": "2019-08-24T14:15:22Z",
- "updatedAt": "2019-08-24T14:15:22Z"
}| id required | string <JSON> DerivedDataset id |
| fk required | string <JSON> Foreign key for origdatablocks |
{- "id": "string",
- "size": 0,
- "dataFileList": [
- {
- "path": "string",
- "size": 0,
- "time": "2019-08-24T14:15:22Z",
- "chk": "string",
- "uid": "string",
- "gid": "string",
- "perm": "string"
}
], - "ownerGroup": "string",
- "accessGroups": [
- "string"
], - "createdBy": "string",
- "updatedBy": "string",
- "datasetId": "string",
- "rawDatasetId": "string",
- "derivedDatasetId": "string",
- "createdAt": "2019-08-24T14:15:22Z",
- "updatedAt": "2019-08-24T14:15:22Z"
}| id required | string <JSON> DerivedDataset id |
| fk required | string <JSON> Foreign key for origdatablocks |
| id | string (ObjectID) ^[a-fA-F\d]{24}$ |
| size required | number <double> Total size in bytes of all files contained in the dataFileList |
required | Array of objects (Datafile) List of files contained in the linked dataset. Files can be regular files, folders and softlinks. All file paths are relative paths with respect to the sourceFolder location of the linked dataset. |
| ownerGroup required | string Defines the group which owns the data, and therefore has unrestricted access to this data. Usually a pgroup like p12151 |
| accessGroups | Array of strings Optional additional groups which have read access to the data. Users which are member in one of the groups listed here are allowed to access this data. The special group 'public' makes data available to all users |
| createdBy | string Functional or user account name who created this instance |
| updatedBy | string Functional or user account name who last updated this instance |
| datasetId | string |
| rawDatasetId | string |
| derivedDatasetId | string |
| createdAt | string <date-time> |
| updatedAt | string <date-time> |
{- "id": "string",
- "size": 0,
- "dataFileList": [
- {
- "path": "string",
- "size": 0,
- "time": "2019-08-24T14:15:22Z",
- "chk": "string",
- "uid": "string",
- "gid": "string",
- "perm": "string"
}
], - "ownerGroup": "string",
- "accessGroups": [
- "string"
], - "createdBy": "string",
- "updatedBy": "string",
- "datasetId": "string",
- "rawDatasetId": "string",
- "derivedDatasetId": "string",
- "createdAt": "2019-08-24T14:15:22Z",
- "updatedAt": "2019-08-24T14:15:22Z"
}{- "id": "string",
- "size": 0,
- "dataFileList": [
- {
- "path": "string",
- "size": 0,
- "time": "2019-08-24T14:15:22Z",
- "chk": "string",
- "uid": "string",
- "gid": "string",
- "perm": "string"
}
], - "ownerGroup": "string",
- "accessGroups": [
- "string"
], - "createdBy": "string",
- "updatedBy": "string",
- "datasetId": "string",
- "rawDatasetId": "string",
- "derivedDatasetId": "string",
- "createdAt": "2019-08-24T14:15:22Z",
- "updatedAt": "2019-08-24T14:15:22Z"
}| id required | string <JSON> DerivedDataset id |
| fk required | string <JSON> Foreign key for historyList |
{- "id": "string"
}| id required | string <JSON> DerivedDataset id |
| fk required | string <JSON> Foreign key for historyList |
| id required | string id currently needed by limitation in embedsmany |
{- "id": "string"
}{- "id": "string"
}| id required | string <JSON> DerivedDataset id |
| fk required | string <JSON> Foreign key for attachments |
{- "thumbnail": "retrieve",
- "caption": "",
- "ownerGroup": "string",
- "accessGroups": [
- "string"
], - "createdBy": "string",
- "updatedBy": "string",
- "id": "string",
- "datasetId": "string",
- "sampleId": "string",
- "proposalId": "string",
- "rawDatasetId": "string",
- "derivedDatasetId": "string",
- "createdAt": "2019-08-24T14:15:22Z",
- "updatedAt": "2019-08-24T14:15:22Z"
}| id required | string <JSON> DerivedDataset id |
| fk required | string <JSON> Foreign key for attachments |
| thumbnail required | string Default: "retrieve" Contains a thumbnail preview in base64 encoded png format for a given dataset |
| caption | string Default: "" Attachment caption to show in catanie |
| ownerGroup required | string Defines the group which owns the data, and therefore has unrestricted access to this data. Usually a pgroup like p12151 |
| accessGroups | Array of strings Optional additional groups which have read access to the data. Users which are member in one of the groups listed here are allowed to access this data. The special group 'public' makes data available to all users |
| createdBy | string Functional or user account name who created this instance |
| updatedBy | string Functional or user account name who last updated this instance |
| id | string (ObjectID) ^[a-fA-F\d]{24}$ |
| datasetId | string |
| sampleId | string |
| proposalId | string |
| rawDatasetId | string |
| derivedDatasetId | string |
| createdAt | string <date-time> |
| updatedAt | string <date-time> |
{- "thumbnail": "retrieve",
- "caption": "",
- "ownerGroup": "string",
- "accessGroups": [
- "string"
], - "createdBy": "string",
- "updatedBy": "string",
- "id": "string",
- "datasetId": "string",
- "sampleId": "string",
- "proposalId": "string",
- "rawDatasetId": "string",
- "derivedDatasetId": "string",
- "createdAt": "2019-08-24T14:15:22Z",
- "updatedAt": "2019-08-24T14:15:22Z"
}{- "thumbnail": "retrieve",
- "caption": "",
- "ownerGroup": "string",
- "accessGroups": [
- "string"
], - "createdBy": "string",
- "updatedBy": "string",
- "id": "string",
- "datasetId": "string",
- "sampleId": "string",
- "proposalId": "string",
- "rawDatasetId": "string",
- "derivedDatasetId": "string",
- "createdAt": "2019-08-24T14:15:22Z",
- "updatedAt": "2019-08-24T14:15:22Z"
}| id required | string <JSON> DerivedDataset id |
| refresh | boolean |
{- "pid": "string",
- "name": "string",
- "customMetadata": { }
}| id required | string <JSON> DerivedDataset id |
| fk required | string <JSON> Foreign key for techniquesList |
{- "pid": "string",
- "name": "string"
}| id required | string <JSON> DerivedDataset id |
| fk required | string <JSON> Foreign key for techniquesList |
| pid required | string Persistent Identifier dervied from UUIDv4 |
| name required | string The name of the technique |
{- "pid": "string",
- "name": "string"
}{- "pid": "string",
- "name": "string"
}| id required | string <JSON> DerivedDataset id |
| filter | string <JSON> |
[- {
- "sampleId": "string",
- "owner": "string",
- "description": "string",
- "createdAt": "2019-08-24T14:15:22Z",
- "sampleCharacteristics": { },
- "isPublished": true,
- "ownerGroup": "string",
- "accessGroups": [
- "string"
], - "createdBy": "string",
- "updatedBy": "string",
- "datasetsId": "string",
- "datasetId": "string",
- "rawDatasetId": "string",
- "derivedDatasetId": "string",
- "updatedAt": "2019-08-24T14:15:22Z"
}
]| id required | string <JSON> DerivedDataset id |
| sampleId required | string |
| owner | string |
| description | string |
| createdAt | string <date-time> |
| sampleCharacteristics | object |
| isPublished | boolean Flag is true when data are made publically available |
| ownerGroup required | string Defines the group which owns the data, and therefore has unrestricted access to this data. Usually a pgroup like p12151 |
| accessGroups | Array of strings Optional additional groups which have read access to the data. Users which are member in one of the groups listed here are allowed to access this data. The special group 'public' makes data available to all users |
| createdBy | string Functional or user account name who created this instance |
| updatedBy | string Functional or user account name who last updated this instance |
| datasetsId | string |
| datasetId | string |
| rawDatasetId | string |
| derivedDatasetId | string |
| updatedAt | string <date-time> |
{- "sampleId": "string",
- "owner": "string",
- "description": "string",
- "createdAt": "2019-08-24T14:15:22Z",
- "sampleCharacteristics": { },
- "isPublished": true,
- "ownerGroup": "string",
- "accessGroups": [
- "string"
], - "createdBy": "string",
- "updatedBy": "string",
- "datasetsId": "string",
- "datasetId": "string",
- "rawDatasetId": "string",
- "derivedDatasetId": "string",
- "updatedAt": "2019-08-24T14:15:22Z"
}{- "sampleId": "string",
- "owner": "string",
- "description": "string",
- "createdAt": "2019-08-24T14:15:22Z",
- "sampleCharacteristics": { },
- "isPublished": true,
- "ownerGroup": "string",
- "accessGroups": [
- "string"
], - "createdBy": "string",
- "updatedBy": "string",
- "datasetsId": "string",
- "datasetId": "string",
- "rawDatasetId": "string",
- "derivedDatasetId": "string",
- "updatedAt": "2019-08-24T14:15:22Z"
}| id required | string <JSON> DerivedDataset id |
| where | string <JSON> Criteria to match model instances |
{- "count": 0
}| id required | string <JSON> DerivedDataset id |
| filter | string <JSON> |
[- {
- "id": "string",
- "archiveId": "string",
- "size": 0,
- "packedSize": 0,
- "chkAlg": "string",
- "version": "string",
- "dataFileList": [
- {
- "path": "string",
- "size": 0,
- "time": "2019-08-24T14:15:22Z",
- "chk": "string",
- "uid": "string",
- "gid": "string",
- "perm": "string"
}
], - "ownerGroup": "string",
- "accessGroups": [
- "string"
], - "createdBy": "string",
- "updatedBy": "string",
- "datasetId": "string",
- "rawDatasetId": "string",
- "derivedDatasetId": "string",
- "createdAt": "2019-08-24T14:15:22Z",
- "updatedAt": "2019-08-24T14:15:22Z"
}
]| id required | string <JSON> DerivedDataset id |
| id required | string Catalog internal UUIDv4 for datablock |
| archiveId required | string Unique identifier given bey archive system to the stored datablock. This id is used when data is retrieved back. |
| size required | number <double> Total size in bytes of all files in datablock when unpacked |
| packedSize | number <double> Size of datablock package file |
| chkAlg | string Algoritm used for calculation of checksums, e.g. sha2 |
| version required | string Version string defining format of how data is packed and stored in archive |
required | Array of objects (Datafile) |
| ownerGroup required | string Defines the group which owns the data, and therefore has unrestricted access to this data. Usually a pgroup like p12151 |
| accessGroups | Array of strings Optional additional groups which have read access to the data. Users which are member in one of the groups listed here are allowed to access this data. The special group 'public' makes data available to all users |
| createdBy | string Functional or user account name who created this instance |
| updatedBy | string Functional or user account name who last updated this instance |
| datasetId | string |
| rawDatasetId | string |
| derivedDatasetId | string |
| createdAt | string <date-time> |
| updatedAt | string <date-time> |
{- "id": "string",
- "archiveId": "string",
- "size": 0,
- "packedSize": 0,
- "chkAlg": "string",
- "version": "string",
- "dataFileList": [
- {
- "path": "string",
- "size": 0,
- "time": "2019-08-24T14:15:22Z",
- "chk": "string",
- "uid": "string",
- "gid": "string",
- "perm": "string"
}
], - "ownerGroup": "string",
- "accessGroups": [
- "string"
], - "createdBy": "string",
- "updatedBy": "string",
- "datasetId": "string",
- "rawDatasetId": "string",
- "derivedDatasetId": "string",
- "createdAt": "2019-08-24T14:15:22Z",
- "updatedAt": "2019-08-24T14:15:22Z"
}{- "id": "string",
- "archiveId": "string",
- "size": 0,
- "packedSize": 0,
- "chkAlg": "string",
- "version": "string",
- "dataFileList": [
- {
- "path": "string",
- "size": 0,
- "time": "2019-08-24T14:15:22Z",
- "chk": "string",
- "uid": "string",
- "gid": "string",
- "perm": "string"
}
], - "ownerGroup": "string",
- "accessGroups": [
- "string"
], - "createdBy": "string",
- "updatedBy": "string",
- "datasetId": "string",
- "rawDatasetId": "string",
- "derivedDatasetId": "string",
- "createdAt": "2019-08-24T14:15:22Z",
- "updatedAt": "2019-08-24T14:15:22Z"
}| id required | string <JSON> DerivedDataset id |
| where | string <JSON> Criteria to match model instances |
{- "count": 0
}| id required | string <JSON> DerivedDataset id |
| filter | string <JSON> |
[- {
- "id": "string",
- "size": 0,
- "dataFileList": [
- {
- "path": "string",
- "size": 0,
- "time": "2019-08-24T14:15:22Z",
- "chk": "string",
- "uid": "string",
- "gid": "string",
- "perm": "string"
}
], - "ownerGroup": "string",
- "accessGroups": [
- "string"
], - "createdBy": "string",
- "updatedBy": "string",
- "datasetId": "string",
- "rawDatasetId": "string",
- "derivedDatasetId": "string",
- "createdAt": "2019-08-24T14:15:22Z",
- "updatedAt": "2019-08-24T14:15:22Z"
}
]| id required | string <JSON> DerivedDataset id |
| id | string (ObjectID) ^[a-fA-F\d]{24}$ |
| size required | number <double> Total size in bytes of all files contained in the dataFileList |
required | Array of objects (Datafile) List of files contained in the linked dataset. Files can be regular files, folders and softlinks. All file paths are relative paths with respect to the sourceFolder location of the linked dataset. |
| ownerGroup required | string Defines the group which owns the data, and therefore has unrestricted access to this data. Usually a pgroup like p12151 |
| accessGroups | Array of strings Optional additional groups which have read access to the data. Users which are member in one of the groups listed here are allowed to access this data. The special group 'public' makes data available to all users |
| createdBy | string Functional or user account name who created this instance |
| updatedBy | string Functional or user account name who last updated this instance |
| datasetId | string |
| rawDatasetId | string |
| derivedDatasetId | string |
| createdAt | string <date-time> |
| updatedAt | string <date-time> |
{- "id": "string",
- "size": 0,
- "dataFileList": [
- {
- "path": "string",
- "size": 0,
- "time": "2019-08-24T14:15:22Z",
- "chk": "string",
- "uid": "string",
- "gid": "string",
- "perm": "string"
}
], - "ownerGroup": "string",
- "accessGroups": [
- "string"
], - "createdBy": "string",
- "updatedBy": "string",
- "datasetId": "string",
- "rawDatasetId": "string",
- "derivedDatasetId": "string",
- "createdAt": "2019-08-24T14:15:22Z",
- "updatedAt": "2019-08-24T14:15:22Z"
}{- "id": "string",
- "size": 0,
- "dataFileList": [
- {
- "path": "string",
- "size": 0,
- "time": "2019-08-24T14:15:22Z",
- "chk": "string",
- "uid": "string",
- "gid": "string",
- "perm": "string"
}
], - "ownerGroup": "string",
- "accessGroups": [
- "string"
], - "createdBy": "string",
- "updatedBy": "string",
- "datasetId": "string",
- "rawDatasetId": "string",
- "derivedDatasetId": "string",
- "createdAt": "2019-08-24T14:15:22Z",
- "updatedAt": "2019-08-24T14:15:22Z"
}| id required | string <JSON> DerivedDataset id |
| where | string <JSON> Criteria to match model instances |
{- "count": 0
}| id required | string <JSON> DerivedDataset id |
| id required | string id currently needed by limitation in embedsmany |
{- "id": "string"
}{- "id": "string"
}| id required | string <JSON> DerivedDataset id |
| where | string <JSON> Criteria to match model instances |
{- "count": 0
}| id required | string <JSON> DerivedDataset id |
| filter | string <JSON> |
[- {
- "thumbnail": "retrieve",
- "caption": "",
- "ownerGroup": "string",
- "accessGroups": [
- "string"
], - "createdBy": "string",
- "updatedBy": "string",
- "id": "string",
- "datasetId": "string",
- "sampleId": "string",
- "proposalId": "string",
- "rawDatasetId": "string",
- "derivedDatasetId": "string",
- "createdAt": "2019-08-24T14:15:22Z",
- "updatedAt": "2019-08-24T14:15:22Z"
}
]| id required | string <JSON> DerivedDataset id |
| thumbnail required | string Default: "retrieve" Contains a thumbnail preview in base64 encoded png format for a given dataset |
| caption | string Default: "" Attachment caption to show in catanie |
| ownerGroup required | string Defines the group which owns the data, and therefore has unrestricted access to this data. Usually a pgroup like p12151 |
| accessGroups | Array of strings Optional additional groups which have read access to the data. Users which are member in one of the groups listed here are allowed to access this data. The special group 'public' makes data available to all users |
| createdBy | string Functional or user account name who created this instance |
| updatedBy | string Functional or user account name who last updated this instance |
| id | string (ObjectID) ^[a-fA-F\d]{24}$ |
| datasetId | string |
| sampleId | string |
| proposalId | string |
| rawDatasetId | string |
| derivedDatasetId | string |
| createdAt | string <date-time> |
| updatedAt | string <date-time> |
{- "thumbnail": "retrieve",
- "caption": "",
- "ownerGroup": "string",
- "accessGroups": [
- "string"
], - "createdBy": "string",
- "updatedBy": "string",
- "id": "string",
- "datasetId": "string",
- "sampleId": "string",
- "proposalId": "string",
- "rawDatasetId": "string",
- "derivedDatasetId": "string",
- "createdAt": "2019-08-24T14:15:22Z",
- "updatedAt": "2019-08-24T14:15:22Z"
}{- "thumbnail": "retrieve",
- "caption": "",
- "ownerGroup": "string",
- "accessGroups": [
- "string"
], - "createdBy": "string",
- "updatedBy": "string",
- "id": "string",
- "datasetId": "string",
- "sampleId": "string",
- "proposalId": "string",
- "rawDatasetId": "string",
- "derivedDatasetId": "string",
- "createdAt": "2019-08-24T14:15:22Z",
- "updatedAt": "2019-08-24T14:15:22Z"
}| id required | string <JSON> DerivedDataset id |
| where | string <JSON> Criteria to match model instances |
{- "count": 0
}| id required | string <JSON> DerivedDataset id |
| filter | string <JSON> |
[- {
- "pid": "string",
- "name": "string"
}
]| id required | string <JSON> DerivedDataset id |
| pid required | string Persistent Identifier dervied from UUIDv4 |
| name required | string The name of the technique |
{- "pid": "string",
- "name": "string"
}{- "pid": "string",
- "name": "string"
}| id required | string <JSON> DerivedDataset id |
| where | string <JSON> Criteria to match model instances |
{- "count": 0
}Model instance data
| investigator required | string Email of person pursuing the data analysis |
| inputDatasets required | Array of strings Array of input dataset identifiers used in producing the derived dataset. Ideally these are the global identifier to existing datasets inside this or federated data catalogs |
| usedSoftware required | Array of strings A list of links to software repositories which uniquely identifies the software used and the version for yielding the derived data |
| jobParameters | object The creation process of the drived data will usually depend on input job parameters. The full structure of these input parameters are stored here |
| jobLogData | string The output job logfile. Keep the size of this log data well below 15 MB |
| scientificMetadata | object JSON object containing the scientific meta data |
| pid required | string Persistent Identifier for datasets derived from UUIDv4 and prepended automatically by site specific PID prefix like 20.500.12345/ |
| owner required | string Owner of the data set, usually first name + lastname |
| ownerEmail | string Email of owner of the data set |
| orcidOfOwner | string ORCID of owner https://orcid.org if available |
| contactEmail required | string Email of contact person for this dataset |
| sourceFolder required | string Absolute file path on file server containing the files of this dataset, e.g. /some/path/to/sourcefolder. In case of a single file dataset, e.g. HDF5 data, it contains the path up to, but excluding the filename. Trailing slashes are removed. |
| sourceFolderHost | string DNS host name of file server hosting sourceFolder, optionally including protocol e.g. [protocol://]fileserver1.example.com |
| size | number <double> Total size of all source files contained in source folder on disk when unpacked |
| packedSize | number <double> Total size of all datablock package files created for this dataset |
| numberOfFiles | number <double> Total number of lines in filelisting of all OrigDatablocks for this dataset |
| numberOfFilesArchived | number <double> Total number of lines in filelisting of all Datablocks for this dataset |
| creationTime required | string <date-time> Time when dataset became fully available on disk, i.e. all containing files have been written. Format according to chapter 5.6 internet date/time format in RFC 3339. Local times without timezone/offset info are automatically transformed to UTC using the timezone of the API server. |
| type required | string Characterize type of dataset, either 'base' or 'raw' or 'derived'. Autofilled when choosing the proper inherited models |
| validationStatus | string Defines a level of trust, e.g. a measure of how much data was verified or used by other persons |
| keywords | Array of strings Array of tags associated with the meaning or contents of this dataset. Values should ideally come from defined vocabularies, taxonomies, ontologies or knowledge graphs |
| description | string Free text explanation of contents of dataset |
| datasetName | string A name for the dataset, given by the creator to carry some semantic meaning. Useful for display purposes e.g. instead of displaying the pid. Will be autofilled if missing using info from sourceFolder |
| classification | string ACIA information about AUthenticity,COnfidentiality,INtegrity and AVailability requirements of dataset. E.g. AV(ailabilty)=medium could trigger the creation of a two tape copies. Format 'AV=medium,CO=low' |
| license | string Name of license under which data can be used |
| version | string Version of API used in creation of dataset |
| isPublished | boolean Flag is true when data are made publically available |
| ownerGroup required | string Defines the group which owns the data, and therefore has unrestricted access to this data. Usually a pgroup like p12151 |
| accessGroups | Array of strings Optional additional groups which have read access to the data. Users which are member in one of the groups listed here are allowed to access this data. The special group 'public' makes data available to all users |
| createdBy | string Functional or user account name who created this instance |
| updatedBy | string Functional or user account name who last updated this instance |
| createdAt | string <date-time> |
| updatedAt | string <date-time> |
| publisheddataId | string |
object (DatasetLifecycle) For each dataset there exists an embedded dataset lifecycle document which describes the current status of the dataset during its lifetime with respect to the storage handling systems | |
Array of objects (Message) | |
| instrumentId | string |
Array of objects (Technique) |
{- "investigator": "string",
- "inputDatasets": [
- "string"
], - "usedSoftware": [
- "string"
], - "jobParameters": { },
- "jobLogData": "string",
- "scientificMetadata": { },
- "pid": "string",
- "owner": "string",
- "ownerEmail": "string",
- "orcidOfOwner": "string",
- "contactEmail": "string",
- "sourceFolder": "string",
- "sourceFolderHost": "string",
- "size": 0,
- "packedSize": 0,
- "numberOfFiles": 0,
- "numberOfFilesArchived": 0,
- "creationTime": "2019-08-24T14:15:22Z",
- "type": "string",
- "validationStatus": "string",
- "keywords": [
- "string"
], - "description": "string",
- "datasetName": "string",
- "classification": "string",
- "license": "string",
- "version": "string",
- "isPublished": true,
- "ownerGroup": "string",
- "accessGroups": [
- "string"
], - "createdBy": "string",
- "updatedBy": "string",
- "createdAt": "2019-08-24T14:15:22Z",
- "updatedAt": "2019-08-24T14:15:22Z",
- "publisheddataId": "string",
- "datasetlifecycle": {
- "archivable": true,
- "retrievable": true,
- "publishable": true,
- "dateOfDiskPurging": "2019-08-24T14:15:22Z",
- "archiveRetentionTime": "2019-08-24T14:15:22Z",
- "dateOfPublishing": "2019-08-24T14:15:22Z",
- "isOnCentralDisk": true,
- "archiveStatusMessage": "string",
- "retrieveStatusMessage": "string",
- "archiveReturnMessage": { },
- "retrieveReturnMessage": { },
- "exportedTo": "string",
- "retrieveIntegrityCheck": true,
- "id": "string"
}, - "history": [
- {
- "id": "string"
}
], - "instrumentId": "string",
- "techniques": [
- {
- "pid": "string",
- "name": "string"
}
]
}{- "investigator": "string",
- "inputDatasets": [
- "string"
], - "usedSoftware": [
- "string"
], - "jobParameters": { },
- "jobLogData": "string",
- "scientificMetadata": { },
- "pid": "string",
- "owner": "string",
- "ownerEmail": "string",
- "orcidOfOwner": "string",
- "contactEmail": "string",
- "sourceFolder": "string",
- "sourceFolderHost": "string",
- "size": 0,
- "packedSize": 0,
- "numberOfFiles": 0,
- "numberOfFilesArchived": 0,
- "creationTime": "2019-08-24T14:15:22Z",
- "type": "string",
- "validationStatus": "string",
- "keywords": [
- "string"
], - "description": "string",
- "datasetName": "string",
- "classification": "string",
- "license": "string",
- "version": "string",
- "isPublished": true,
- "ownerGroup": "string",
- "accessGroups": [
- "string"
], - "createdBy": "string",
- "updatedBy": "string",
- "createdAt": "2019-08-24T14:15:22Z",
- "updatedAt": "2019-08-24T14:15:22Z",
- "publisheddataId": "string",
- "datasetlifecycle": {
- "archivable": true,
- "retrievable": true,
- "publishable": true,
- "dateOfDiskPurging": "2019-08-24T14:15:22Z",
- "archiveRetentionTime": "2019-08-24T14:15:22Z",
- "dateOfPublishing": "2019-08-24T14:15:22Z",
- "isOnCentralDisk": true,
- "archiveStatusMessage": "string",
- "retrieveStatusMessage": "string",
- "archiveReturnMessage": { },
- "retrieveReturnMessage": { },
- "exportedTo": "string",
- "retrieveIntegrityCheck": true,
- "id": "string"
}, - "history": [
- {
- "id": "string"
}
], - "instrumentId": "string",
- "techniques": [
- {
- "pid": "string",
- "name": "string"
}
]
}Model instance data
| investigator required | string Email of person pursuing the data analysis |
| inputDatasets required | Array of strings Array of input dataset identifiers used in producing the derived dataset. Ideally these are the global identifier to existing datasets inside this or federated data catalogs |
| usedSoftware required | Array of strings A list of links to software repositories which uniquely identifies the software used and the version for yielding the derived data |
| jobParameters | object The creation process of the drived data will usually depend on input job parameters. The full structure of these input parameters are stored here |
| jobLogData | string The output job logfile. Keep the size of this log data well below 15 MB |
| scientificMetadata | object JSON object containing the scientific meta data |
| pid required | string Persistent Identifier for datasets derived from UUIDv4 and prepended automatically by site specific PID prefix like 20.500.12345/ |
| owner required | string Owner of the data set, usually first name + lastname |
| ownerEmail | string Email of owner of the data set |
| orcidOfOwner | string ORCID of owner https://orcid.org if available |
| contactEmail required | string Email of contact person for this dataset |
| sourceFolder required | string Absolute file path on file server containing the files of this dataset, e.g. /some/path/to/sourcefolder. In case of a single file dataset, e.g. HDF5 data, it contains the path up to, but excluding the filename. Trailing slashes are removed. |
| sourceFolderHost | string DNS host name of file server hosting sourceFolder, optionally including protocol e.g. [protocol://]fileserver1.example.com |
| size | number <double> Total size of all source files contained in source folder on disk when unpacked |
| packedSize | number <double> Total size of all datablock package files created for this dataset |
| numberOfFiles | number <double> Total number of lines in filelisting of all OrigDatablocks for this dataset |
| numberOfFilesArchived | number <double> Total number of lines in filelisting of all Datablocks for this dataset |
| creationTime required | string <date-time> Time when dataset became fully available on disk, i.e. all containing files have been written. Format according to chapter 5.6 internet date/time format in RFC 3339. Local times without timezone/offset info are automatically transformed to UTC using the timezone of the API server. |
| type required | string Characterize type of dataset, either 'base' or 'raw' or 'derived'. Autofilled when choosing the proper inherited models |
| validationStatus | string Defines a level of trust, e.g. a measure of how much data was verified or used by other persons |
| keywords | Array of strings Array of tags associated with the meaning or contents of this dataset. Values should ideally come from defined vocabularies, taxonomies, ontologies or knowledge graphs |
| description | string Free text explanation of contents of dataset |
| datasetName | string A name for the dataset, given by the creator to carry some semantic meaning. Useful for display purposes e.g. instead of displaying the pid. Will be autofilled if missing using info from sourceFolder |
| classification | string ACIA information about AUthenticity,COnfidentiality,INtegrity and AVailability requirements of dataset. E.g. AV(ailabilty)=medium could trigger the creation of a two tape copies. Format 'AV=medium,CO=low' |
| license | string Name of license under which data can be used |
| version | string Version of API used in creation of dataset |
| isPublished | boolean Flag is true when data are made publically available |
| ownerGroup required | string Defines the group which owns the data, and therefore has unrestricted access to this data. Usually a pgroup like p12151 |
| accessGroups | Array of strings Optional additional groups which have read access to the data. Users which are member in one of the groups listed here are allowed to access this data. The special group 'public' makes data available to all users |
| createdBy | string Functional or user account name who created this instance |
| updatedBy | string Functional or user account name who last updated this instance |
| createdAt | string <date-time> |
| updatedAt | string <date-time> |
| publisheddataId | string |
object (DatasetLifecycle) For each dataset there exists an embedded dataset lifecycle document which describes the current status of the dataset during its lifetime with respect to the storage handling systems | |
Array of objects (Message) | |
| instrumentId | string |
Array of objects (Technique) |
{- "investigator": "string",
- "inputDatasets": [
- "string"
], - "usedSoftware": [
- "string"
], - "jobParameters": { },
- "jobLogData": "string",
- "scientificMetadata": { },
- "pid": "string",
- "owner": "string",
- "ownerEmail": "string",
- "orcidOfOwner": "string",
- "contactEmail": "string",
- "sourceFolder": "string",
- "sourceFolderHost": "string",
- "size": 0,
- "packedSize": 0,
- "numberOfFiles": 0,
- "numberOfFilesArchived": 0,
- "creationTime": "2019-08-24T14:15:22Z",
- "type": "string",
- "validationStatus": "string",
- "keywords": [
- "string"
], - "description": "string",
- "datasetName": "string",
- "classification": "string",
- "license": "string",
- "version": "string",
- "isPublished": true,
- "ownerGroup": "string",
- "accessGroups": [
- "string"
], - "createdBy": "string",
- "updatedBy": "string",
- "createdAt": "2019-08-24T14:15:22Z",
- "updatedAt": "2019-08-24T14:15:22Z",
- "publisheddataId": "string",
- "datasetlifecycle": {
- "archivable": true,
- "retrievable": true,
- "publishable": true,
- "dateOfDiskPurging": "2019-08-24T14:15:22Z",
- "archiveRetentionTime": "2019-08-24T14:15:22Z",
- "dateOfPublishing": "2019-08-24T14:15:22Z",
- "isOnCentralDisk": true,
- "archiveStatusMessage": "string",
- "retrieveStatusMessage": "string",
- "archiveReturnMessage": { },
- "retrieveReturnMessage": { },
- "exportedTo": "string",
- "retrieveIntegrityCheck": true,
- "id": "string"
}, - "history": [
- {
- "id": "string"
}
], - "instrumentId": "string",
- "techniques": [
- {
- "pid": "string",
- "name": "string"
}
]
}{- "investigator": "string",
- "inputDatasets": [
- "string"
], - "usedSoftware": [
- "string"
], - "jobParameters": { },
- "jobLogData": "string",
- "scientificMetadata": { },
- "pid": "string",
- "owner": "string",
- "ownerEmail": "string",
- "orcidOfOwner": "string",
- "contactEmail": "string",
- "sourceFolder": "string",
- "sourceFolderHost": "string",
- "size": 0,
- "packedSize": 0,
- "numberOfFiles": 0,
- "numberOfFilesArchived": 0,
- "creationTime": "2019-08-24T14:15:22Z",
- "type": "string",
- "validationStatus": "string",
- "keywords": [
- "string"
], - "description": "string",
- "datasetName": "string",
- "classification": "string",
- "license": "string",
- "version": "string",
- "isPublished": true,
- "ownerGroup": "string",
- "accessGroups": [
- "string"
], - "createdBy": "string",
- "updatedBy": "string",
- "createdAt": "2019-08-24T14:15:22Z",
- "updatedAt": "2019-08-24T14:15:22Z",
- "publisheddataId": "string",
- "datasetlifecycle": {
- "archivable": true,
- "retrievable": true,
- "publishable": true,
- "dateOfDiskPurging": "2019-08-24T14:15:22Z",
- "archiveRetentionTime": "2019-08-24T14:15:22Z",
- "dateOfPublishing": "2019-08-24T14:15:22Z",
- "isOnCentralDisk": true,
- "archiveStatusMessage": "string",
- "retrieveStatusMessage": "string",
- "archiveReturnMessage": { },
- "retrieveReturnMessage": { },
- "exportedTo": "string",
- "retrieveIntegrityCheck": true,
- "id": "string"
}, - "history": [
- {
- "id": "string"
}
], - "instrumentId": "string",
- "techniques": [
- {
- "pid": "string",
- "name": "string"
}
]
}Model instance data
| investigator required | string Email of person pursuing the data analysis |
| inputDatasets required | Array of strings Array of input dataset identifiers used in producing the derived dataset. Ideally these are the global identifier to existing datasets inside this or federated data catalogs |
| usedSoftware required | Array of strings A list of links to software repositories which uniquely identifies the software used and the version for yielding the derived data |
| jobParameters | object The creation process of the drived data will usually depend on input job parameters. The full structure of these input parameters are stored here |
| jobLogData | string The output job logfile. Keep the size of this log data well below 15 MB |
| scientificMetadata | object JSON object containing the scientific meta data |
| pid required | string Persistent Identifier for datasets derived from UUIDv4 and prepended automatically by site specific PID prefix like 20.500.12345/ |
| owner required | string Owner of the data set, usually first name + lastname |
| ownerEmail | string Email of owner of the data set |
| orcidOfOwner | string ORCID of owner https://orcid.org if available |
| contactEmail required | string Email of contact person for this dataset |
| sourceFolder required | string Absolute file path on file server containing the files of this dataset, e.g. /some/path/to/sourcefolder. In case of a single file dataset, e.g. HDF5 data, it contains the path up to, but excluding the filename. Trailing slashes are removed. |
| sourceFolderHost | string DNS host name of file server hosting sourceFolder, optionally including protocol e.g. [protocol://]fileserver1.example.com |
| size | number <double> Total size of all source files contained in source folder on disk when unpacked |
| packedSize | number <double> Total size of all datablock package files created for this dataset |
| numberOfFiles | number <double> Total number of lines in filelisting of all OrigDatablocks for this dataset |
| numberOfFilesArchived | number <double> Total number of lines in filelisting of all Datablocks for this dataset |
| creationTime required | string <date-time> Time when dataset became fully available on disk, i.e. all containing files have been written. Format according to chapter 5.6 internet date/time format in RFC 3339. Local times without timezone/offset info are automatically transformed to UTC using the timezone of the API server. |
| type required | string Characterize type of dataset, either 'base' or 'raw' or 'derived'. Autofilled when choosing the proper inherited models |
| validationStatus | string Defines a level of trust, e.g. a measure of how much data was verified or used by other persons |
| keywords | Array of strings Array of tags associated with the meaning or contents of this dataset. Values should ideally come from defined vocabularies, taxonomies, ontologies or knowledge graphs |
| description | string Free text explanation of contents of dataset |
| datasetName | string A name for the dataset, given by the creator to carry some semantic meaning. Useful for display purposes e.g. instead of displaying the pid. Will be autofilled if missing using info from sourceFolder |
| classification | string ACIA information about AUthenticity,COnfidentiality,INtegrity and AVailability requirements of dataset. E.g. AV(ailabilty)=medium could trigger the creation of a two tape copies. Format 'AV=medium,CO=low' |
| license | string Name of license under which data can be used |
| version | string Version of API used in creation of dataset |
| isPublished | boolean Flag is true when data are made publically available |
| ownerGroup required | string Defines the group which owns the data, and therefore has unrestricted access to this data. Usually a pgroup like p12151 |
| accessGroups | Array of strings Optional additional groups which have read access to the data. Users which are member in one of the groups listed here are allowed to access this data. The special group 'public' makes data available to all users |
| createdBy | string Functional or user account name who created this instance |
| updatedBy | string Functional or user account name who last updated this instance |
| createdAt | string <date-time> |
| updatedAt | string <date-time> |
| publisheddataId | string |
object (DatasetLifecycle) For each dataset there exists an embedded dataset lifecycle document which describes the current status of the dataset during its lifetime with respect to the storage handling systems | |
Array of objects (Message) | |
| instrumentId | string |
Array of objects (Technique) |
{- "investigator": "string",
- "inputDatasets": [
- "string"
], - "usedSoftware": [
- "string"
], - "jobParameters": { },
- "jobLogData": "string",
- "scientificMetadata": { },
- "pid": "string",
- "owner": "string",
- "ownerEmail": "string",
- "orcidOfOwner": "string",
- "contactEmail": "string",
- "sourceFolder": "string",
- "sourceFolderHost": "string",
- "size": 0,
- "packedSize": 0,
- "numberOfFiles": 0,
- "numberOfFilesArchived": 0,
- "creationTime": "2019-08-24T14:15:22Z",
- "type": "string",
- "validationStatus": "string",
- "keywords": [
- "string"
], - "description": "string",
- "datasetName": "string",
- "classification": "string",
- "license": "string",
- "version": "string",
- "isPublished": true,
- "ownerGroup": "string",
- "accessGroups": [
- "string"
], - "createdBy": "string",
- "updatedBy": "string",
- "createdAt": "2019-08-24T14:15:22Z",
- "updatedAt": "2019-08-24T14:15:22Z",
- "publisheddataId": "string",
- "datasetlifecycle": {
- "archivable": true,
- "retrievable": true,
- "publishable": true,
- "dateOfDiskPurging": "2019-08-24T14:15:22Z",
- "archiveRetentionTime": "2019-08-24T14:15:22Z",
- "dateOfPublishing": "2019-08-24T14:15:22Z",
- "isOnCentralDisk": true,
- "archiveStatusMessage": "string",
- "retrieveStatusMessage": "string",
- "archiveReturnMessage": { },
- "retrieveReturnMessage": { },
- "exportedTo": "string",
- "retrieveIntegrityCheck": true,
- "id": "string"
}, - "history": [
- {
- "id": "string"
}
], - "instrumentId": "string",
- "techniques": [
- {
- "pid": "string",
- "name": "string"
}
]
}{- "investigator": "string",
- "inputDatasets": [
- "string"
], - "usedSoftware": [
- "string"
], - "jobParameters": { },
- "jobLogData": "string",
- "scientificMetadata": { },
- "pid": "string",
- "owner": "string",
- "ownerEmail": "string",
- "orcidOfOwner": "string",
- "contactEmail": "string",
- "sourceFolder": "string",
- "sourceFolderHost": "string",
- "size": 0,
- "packedSize": 0,
- "numberOfFiles": 0,
- "numberOfFilesArchived": 0,
- "creationTime": "2019-08-24T14:15:22Z",
- "type": "string",
- "validationStatus": "string",
- "keywords": [
- "string"
], - "description": "string",
- "datasetName": "string",
- "classification": "string",
- "license": "string",
- "version": "string",
- "isPublished": true,
- "ownerGroup": "string",
- "accessGroups": [
- "string"
], - "createdBy": "string",
- "updatedBy": "string",
- "createdAt": "2019-08-24T14:15:22Z",
- "updatedAt": "2019-08-24T14:15:22Z",
- "publisheddataId": "string",
- "datasetlifecycle": {
- "archivable": true,
- "retrievable": true,
- "publishable": true,
- "dateOfDiskPurging": "2019-08-24T14:15:22Z",
- "archiveRetentionTime": "2019-08-24T14:15:22Z",
- "dateOfPublishing": "2019-08-24T14:15:22Z",
- "isOnCentralDisk": true,
- "archiveStatusMessage": "string",
- "retrieveStatusMessage": "string",
- "archiveReturnMessage": { },
- "retrieveReturnMessage": { },
- "exportedTo": "string",
- "retrieveIntegrityCheck": true,
- "id": "string"
}, - "history": [
- {
- "id": "string"
}
], - "instrumentId": "string",
- "techniques": [
- {
- "pid": "string",
- "name": "string"
}
]
}| filter | string <JSON> Filter defining fields, where, include, order, offset, and limit - must be a JSON-encoded string ( |
[- {
- "investigator": "string",
- "inputDatasets": [
- "string"
], - "usedSoftware": [
- "string"
], - "jobParameters": { },
- "jobLogData": "string",
- "scientificMetadata": { },
- "pid": "string",
- "owner": "string",
- "ownerEmail": "string",
- "orcidOfOwner": "string",
- "contactEmail": "string",
- "sourceFolder": "string",
- "sourceFolderHost": "string",
- "size": 0,
- "packedSize": 0,
- "numberOfFiles": 0,
- "numberOfFilesArchived": 0,
- "creationTime": "2019-08-24T14:15:22Z",
- "type": "string",
- "validationStatus": "string",
- "keywords": [
- "string"
], - "description": "string",
- "datasetName": "string",
- "classification": "string",
- "license": "string",
- "version": "string",
- "isPublished": true,
- "ownerGroup": "string",
- "accessGroups": [
- "string"
], - "createdBy": "string",
- "updatedBy": "string",
- "createdAt": "2019-08-24T14:15:22Z",
- "updatedAt": "2019-08-24T14:15:22Z",
- "publisheddataId": "string",
- "datasetlifecycle": {
- "archivable": true,
- "retrievable": true,
- "publishable": true,
- "dateOfDiskPurging": "2019-08-24T14:15:22Z",
- "archiveRetentionTime": "2019-08-24T14:15:22Z",
- "dateOfPublishing": "2019-08-24T14:15:22Z",
- "isOnCentralDisk": true,
- "archiveStatusMessage": "string",
- "retrieveStatusMessage": "string",
- "archiveReturnMessage": { },
- "retrieveReturnMessage": { },
- "exportedTo": "string",
- "retrieveIntegrityCheck": true,
- "id": "string"
}, - "history": [
- {
- "id": "string"
}
], - "instrumentId": "string",
- "techniques": [
- {
- "pid": "string",
- "name": "string"
}
]
}
]Model instance data
| investigator required | string Email of person pursuing the data analysis |
| inputDatasets required | Array of strings Array of input dataset identifiers used in producing the derived dataset. Ideally these are the global identifier to existing datasets inside this or federated data catalogs |
| usedSoftware required | Array of strings A list of links to software repositories which uniquely identifies the software used and the version for yielding the derived data |
| jobParameters | object The creation process of the drived data will usually depend on input job parameters. The full structure of these input parameters are stored here |
| jobLogData | string The output job logfile. Keep the size of this log data well below 15 MB |
| scientificMetadata | object JSON object containing the scientific meta data |
| pid required | string Persistent Identifier for datasets derived from UUIDv4 and prepended automatically by site specific PID prefix like 20.500.12345/ |
| owner required | string Owner of the data set, usually first name + lastname |
| ownerEmail | string Email of owner of the data set |
| orcidOfOwner | string ORCID of owner https://orcid.org if available |
| contactEmail required | string Email of contact person for this dataset |
| sourceFolder required | string Absolute file path on file server containing the files of this dataset, e.g. /some/path/to/sourcefolder. In case of a single file dataset, e.g. HDF5 data, it contains the path up to, but excluding the filename. Trailing slashes are removed. |
| sourceFolderHost | string DNS host name of file server hosting sourceFolder, optionally including protocol e.g. [protocol://]fileserver1.example.com |
| size | number <double> Total size of all source files contained in source folder on disk when unpacked |
| packedSize | number <double> Total size of all datablock package files created for this dataset |
| numberOfFiles | number <double> Total number of lines in filelisting of all OrigDatablocks for this dataset |
| numberOfFilesArchived | number <double> Total number of lines in filelisting of all Datablocks for this dataset |
| creationTime required | string <date-time> Time when dataset became fully available on disk, i.e. all containing files have been written. Format according to chapter 5.6 internet date/time format in RFC 3339. Local times without timezone/offset info are automatically transformed to UTC using the timezone of the API server. |
| type required | string Characterize type of dataset, either 'base' or 'raw' or 'derived'. Autofilled when choosing the proper inherited models |
| validationStatus | string Defines a level of trust, e.g. a measure of how much data was verified or used by other persons |
| keywords | Array of strings Array of tags associated with the meaning or contents of this dataset. Values should ideally come from defined vocabularies, taxonomies, ontologies or knowledge graphs |
| description | string Free text explanation of contents of dataset |
| datasetName | string A name for the dataset, given by the creator to carry some semantic meaning. Useful for display purposes e.g. instead of displaying the pid. Will be autofilled if missing using info from sourceFolder |
| classification | string ACIA information about AUthenticity,COnfidentiality,INtegrity and AVailability requirements of dataset. E.g. AV(ailabilty)=medium could trigger the creation of a two tape copies. Format 'AV=medium,CO=low' |
| license | string Name of license under which data can be used |
| version | string Version of API used in creation of dataset |
| isPublished | boolean Flag is true when data are made publically available |
| ownerGroup required | string Defines the group which owns the data, and therefore has unrestricted access to this data. Usually a pgroup like p12151 |
| accessGroups | Array of strings Optional additional groups which have read access to the data. Users which are member in one of the groups listed here are allowed to access this data. The special group 'public' makes data available to all users |
| createdBy | string Functional or user account name who created this instance |
| updatedBy | string Functional or user account name who last updated this instance |
| createdAt | string <date-time> |
| updatedAt | string <date-time> |
| publisheddataId | string |
object (DatasetLifecycle) For each dataset there exists an embedded dataset lifecycle document which describes the current status of the dataset during its lifetime with respect to the storage handling systems | |
Array of objects (Message) | |
| instrumentId | string |
Array of objects (Technique) |
{- "investigator": "string",
- "inputDatasets": [
- "string"
], - "usedSoftware": [
- "string"
], - "jobParameters": { },
- "jobLogData": "string",
- "scientificMetadata": { },
- "pid": "string",
- "owner": "string",
- "ownerEmail": "string",
- "orcidOfOwner": "string",
- "contactEmail": "string",
- "sourceFolder": "string",
- "sourceFolderHost": "string",
- "size": 0,
- "packedSize": 0,
- "numberOfFiles": 0,
- "numberOfFilesArchived": 0,
- "creationTime": "2019-08-24T14:15:22Z",
- "type": "string",
- "validationStatus": "string",
- "keywords": [
- "string"
], - "description": "string",
- "datasetName": "string",
- "classification": "string",
- "license": "string",
- "version": "string",
- "isPublished": true,
- "ownerGroup": "string",
- "accessGroups": [
- "string"
], - "createdBy": "string",
- "updatedBy": "string",
- "createdAt": "2019-08-24T14:15:22Z",
- "updatedAt": "2019-08-24T14:15:22Z",
- "publisheddataId": "string",
- "datasetlifecycle": {
- "archivable": true,
- "retrievable": true,
- "publishable": true,
- "dateOfDiskPurging": "2019-08-24T14:15:22Z",
- "archiveRetentionTime": "2019-08-24T14:15:22Z",
- "dateOfPublishing": "2019-08-24T14:15:22Z",
- "isOnCentralDisk": true,
- "archiveStatusMessage": "string",
- "retrieveStatusMessage": "string",
- "archiveReturnMessage": { },
- "retrieveReturnMessage": { },
- "exportedTo": "string",
- "retrieveIntegrityCheck": true,
- "id": "string"
}, - "history": [
- {
- "id": "string"
}
], - "instrumentId": "string",
- "techniques": [
- {
- "pid": "string",
- "name": "string"
}
]
}{- "investigator": "string",
- "inputDatasets": [
- "string"
], - "usedSoftware": [
- "string"
], - "jobParameters": { },
- "jobLogData": "string",
- "scientificMetadata": { },
- "pid": "string",
- "owner": "string",
- "ownerEmail": "string",
- "orcidOfOwner": "string",
- "contactEmail": "string",
- "sourceFolder": "string",
- "sourceFolderHost": "string",
- "size": 0,
- "packedSize": 0,
- "numberOfFiles": 0,
- "numberOfFilesArchived": 0,
- "creationTime": "2019-08-24T14:15:22Z",
- "type": "string",
- "validationStatus": "string",
- "keywords": [
- "string"
], - "description": "string",
- "datasetName": "string",
- "classification": "string",
- "license": "string",
- "version": "string",
- "isPublished": true,
- "ownerGroup": "string",
- "accessGroups": [
- "string"
], - "createdBy": "string",
- "updatedBy": "string",
- "createdAt": "2019-08-24T14:15:22Z",
- "updatedAt": "2019-08-24T14:15:22Z",
- "publisheddataId": "string",
- "datasetlifecycle": {
- "archivable": true,
- "retrievable": true,
- "publishable": true,
- "dateOfDiskPurging": "2019-08-24T14:15:22Z",
- "archiveRetentionTime": "2019-08-24T14:15:22Z",
- "dateOfPublishing": "2019-08-24T14:15:22Z",
- "isOnCentralDisk": true,
- "archiveStatusMessage": "string",
- "retrieveStatusMessage": "string",
- "archiveReturnMessage": { },
- "retrieveReturnMessage": { },
- "exportedTo": "string",
- "retrieveIntegrityCheck": true,
- "id": "string"
}, - "history": [
- {
- "id": "string"
}
], - "instrumentId": "string",
- "techniques": [
- {
- "pid": "string",
- "name": "string"
}
]
}| where | string <JSON> Criteria to match model instances |
An object of model property name/value pairs
| investigator required | string Email of person pursuing the data analysis |
| inputDatasets required | Array of strings Array of input dataset identifiers used in producing the derived dataset. Ideally these are the global identifier to existing datasets inside this or federated data catalogs |
| usedSoftware required | Array of strings A list of links to software repositories which uniquely identifies the software used and the version for yielding the derived data |
| jobParameters | object The creation process of the drived data will usually depend on input job parameters. The full structure of these input parameters are stored here |
| jobLogData | string The output job logfile. Keep the size of this log data well below 15 MB |
| scientificMetadata | object JSON object containing the scientific meta data |
| pid required | string Persistent Identifier for datasets derived from UUIDv4 and prepended automatically by site specific PID prefix like 20.500.12345/ |
| owner required | string Owner of the data set, usually first name + lastname |
| ownerEmail | string Email of owner of the data set |
| orcidOfOwner | string ORCID of owner https://orcid.org if available |
| contactEmail required | string Email of contact person for this dataset |
| sourceFolder required | string Absolute file path on file server containing the files of this dataset, e.g. /some/path/to/sourcefolder. In case of a single file dataset, e.g. HDF5 data, it contains the path up to, but excluding the filename. Trailing slashes are removed. |
| sourceFolderHost | string DNS host name of file server hosting sourceFolder, optionally including protocol e.g. [protocol://]fileserver1.example.com |
| size | number <double> Total size of all source files contained in source folder on disk when unpacked |
| packedSize | number <double> Total size of all datablock package files created for this dataset |
| numberOfFiles | number <double> Total number of lines in filelisting of all OrigDatablocks for this dataset |
| numberOfFilesArchived | number <double> Total number of lines in filelisting of all Datablocks for this dataset |
| creationTime required | string <date-time> Time when dataset became fully available on disk, i.e. all containing files have been written. Format according to chapter 5.6 internet date/time format in RFC 3339. Local times without timezone/offset info are automatically transformed to UTC using the timezone of the API server. |
| type required | string Characterize type of dataset, either 'base' or 'raw' or 'derived'. Autofilled when choosing the proper inherited models |
| validationStatus | string Defines a level of trust, e.g. a measure of how much data was verified or used by other persons |
| keywords | Array of strings Array of tags associated with the meaning or contents of this dataset. Values should ideally come from defined vocabularies, taxonomies, ontologies or knowledge graphs |
| description | string Free text explanation of contents of dataset |
| datasetName | string A name for the dataset, given by the creator to carry some semantic meaning. Useful for display purposes e.g. instead of displaying the pid. Will be autofilled if missing using info from sourceFolder |
| classification | string ACIA information about AUthenticity,COnfidentiality,INtegrity and AVailability requirements of dataset. E.g. AV(ailabilty)=medium could trigger the creation of a two tape copies. Format 'AV=medium,CO=low' |
| license | string Name of license under which data can be used |
| version | string Version of API used in creation of dataset |
| isPublished | boolean Flag is true when data are made publically available |
| ownerGroup required | string Defines the group which owns the data, and therefore has unrestricted access to this data. Usually a pgroup like p12151 |
| accessGroups | Array of strings Optional additional groups which have read access to the data. Users which are member in one of the groups listed here are allowed to access this data. The special group 'public' makes data available to all users |
| createdBy | string Functional or user account name who created this instance |
| updatedBy | string Functional or user account name who last updated this instance |
| createdAt | string <date-time> |
| updatedAt | string <date-time> |
| publisheddataId | string |
object (DatasetLifecycle) For each dataset there exists an embedded dataset lifecycle document which describes the current status of the dataset during its lifetime with respect to the storage handling systems | |
Array of objects (Message) | |
| instrumentId | string |
Array of objects (Technique) |
{- "investigator": "string",
- "inputDatasets": [
- "string"
], - "usedSoftware": [
- "string"
], - "jobParameters": { },
- "jobLogData": "string",
- "scientificMetadata": { },
- "pid": "string",
- "owner": "string",
- "ownerEmail": "string",
- "orcidOfOwner": "string",
- "contactEmail": "string",
- "sourceFolder": "string",
- "sourceFolderHost": "string",
- "size": 0,
- "packedSize": 0,
- "numberOfFiles": 0,
- "numberOfFilesArchived": 0,
- "creationTime": "2019-08-24T14:15:22Z",
- "type": "string",
- "validationStatus": "string",
- "keywords": [
- "string"
], - "description": "string",
- "datasetName": "string",
- "classification": "string",
- "license": "string",
- "version": "string",
- "isPublished": true,
- "ownerGroup": "string",
- "accessGroups": [
- "string"
], - "createdBy": "string",
- "updatedBy": "string",
- "createdAt": "2019-08-24T14:15:22Z",
- "updatedAt": "2019-08-24T14:15:22Z",
- "publisheddataId": "string",
- "datasetlifecycle": {
- "archivable": true,
- "retrievable": true,
- "publishable": true,
- "dateOfDiskPurging": "2019-08-24T14:15:22Z",
- "archiveRetentionTime": "2019-08-24T14:15:22Z",
- "dateOfPublishing": "2019-08-24T14:15:22Z",
- "isOnCentralDisk": true,
- "archiveStatusMessage": "string",
- "retrieveStatusMessage": "string",
- "archiveReturnMessage": { },
- "retrieveReturnMessage": { },
- "exportedTo": "string",
- "retrieveIntegrityCheck": true,
- "id": "string"
}, - "history": [
- {
- "id": "string"
}
], - "instrumentId": "string",
- "techniques": [
- {
- "pid": "string",
- "name": "string"
}
]
}{- "investigator": "string",
- "inputDatasets": [
- "string"
], - "usedSoftware": [
- "string"
], - "jobParameters": { },
- "jobLogData": "string",
- "scientificMetadata": { },
- "pid": "string",
- "owner": "string",
- "ownerEmail": "string",
- "orcidOfOwner": "string",
- "contactEmail": "string",
- "sourceFolder": "string",
- "sourceFolderHost": "string",
- "size": 0,
- "packedSize": 0,
- "numberOfFiles": 0,
- "numberOfFilesArchived": 0,
- "creationTime": "2019-08-24T14:15:22Z",
- "type": "string",
- "validationStatus": "string",
- "keywords": [
- "string"
], - "description": "string",
- "datasetName": "string",
- "classification": "string",
- "license": "string",
- "version": "string",
- "isPublished": true,
- "ownerGroup": "string",
- "accessGroups": [
- "string"
], - "createdBy": "string",
- "updatedBy": "string",
- "createdAt": "2019-08-24T14:15:22Z",
- "updatedAt": "2019-08-24T14:15:22Z",
- "publisheddataId": "string",
- "datasetlifecycle": {
- "archivable": true,
- "retrievable": true,
- "publishable": true,
- "dateOfDiskPurging": "2019-08-24T14:15:22Z",
- "archiveRetentionTime": "2019-08-24T14:15:22Z",
- "dateOfPublishing": "2019-08-24T14:15:22Z",
- "isOnCentralDisk": true,
- "archiveStatusMessage": "string",
- "retrieveStatusMessage": "string",
- "archiveReturnMessage": { },
- "retrieveReturnMessage": { },
- "exportedTo": "string",
- "retrieveIntegrityCheck": true,
- "id": "string"
}, - "history": [
- {
- "id": "string"
}
], - "instrumentId": "string",
- "techniques": [
- {
- "pid": "string",
- "name": "string"
}
]
}| id required | string <JSON> Model id |
| filter | string <JSON> Filter defining fields and include - must be a JSON-encoded string ({"something":"value"}) |
{- "investigator": "string",
- "inputDatasets": [
- "string"
], - "usedSoftware": [
- "string"
], - "jobParameters": { },
- "jobLogData": "string",
- "scientificMetadata": { },
- "pid": "string",
- "owner": "string",
- "ownerEmail": "string",
- "orcidOfOwner": "string",
- "contactEmail": "string",
- "sourceFolder": "string",
- "sourceFolderHost": "string",
- "size": 0,
- "packedSize": 0,
- "numberOfFiles": 0,
- "numberOfFilesArchived": 0,
- "creationTime": "2019-08-24T14:15:22Z",
- "type": "string",
- "validationStatus": "string",
- "keywords": [
- "string"
], - "description": "string",
- "datasetName": "string",
- "classification": "string",
- "license": "string",
- "version": "string",
- "isPublished": true,
- "ownerGroup": "string",
- "accessGroups": [
- "string"
], - "createdBy": "string",
- "updatedBy": "string",
- "createdAt": "2019-08-24T14:15:22Z",
- "updatedAt": "2019-08-24T14:15:22Z",
- "publisheddataId": "string",
- "datasetlifecycle": {
- "archivable": true,
- "retrievable": true,
- "publishable": true,
- "dateOfDiskPurging": "2019-08-24T14:15:22Z",
- "archiveRetentionTime": "2019-08-24T14:15:22Z",
- "dateOfPublishing": "2019-08-24T14:15:22Z",
- "isOnCentralDisk": true,
- "archiveStatusMessage": "string",
- "retrieveStatusMessage": "string",
- "archiveReturnMessage": { },
- "retrieveReturnMessage": { },
- "exportedTo": "string",
- "retrieveIntegrityCheck": true,
- "id": "string"
}, - "history": [
- {
- "id": "string"
}
], - "instrumentId": "string",
- "techniques": [
- {
- "pid": "string",
- "name": "string"
}
]
}| id required | string <JSON> DerivedDataset id |
An object of model property name/value pairs
| investigator required | string Email of person pursuing the data analysis |
| inputDatasets required | Array of strings Array of input dataset identifiers used in producing the derived dataset. Ideally these are the global identifier to existing datasets inside this or federated data catalogs |
| usedSoftware required | Array of strings A list of links to software repositories which uniquely identifies the software used and the version for yielding the derived data |
| jobParameters | object The creation process of the drived data will usually depend on input job parameters. The full structure of these input parameters are stored here |
| jobLogData | string The output job logfile. Keep the size of this log data well below 15 MB |
| scientificMetadata | object JSON object containing the scientific meta data |
| pid required | string Persistent Identifier for datasets derived from UUIDv4 and prepended automatically by site specific PID prefix like 20.500.12345/ |
| owner required | string Owner of the data set, usually first name + lastname |
| ownerEmail | string Email of owner of the data set |
| orcidOfOwner | string ORCID of owner https://orcid.org if available |
| contactEmail required | string Email of contact person for this dataset |
| sourceFolder required | string Absolute file path on file server containing the files of this dataset, e.g. /some/path/to/sourcefolder. In case of a single file dataset, e.g. HDF5 data, it contains the path up to, but excluding the filename. Trailing slashes are removed. |
| sourceFolderHost | string DNS host name of file server hosting sourceFolder, optionally including protocol e.g. [protocol://]fileserver1.example.com |
| size | number <double> Total size of all source files contained in source folder on disk when unpacked |
| packedSize | number <double> Total size of all datablock package files created for this dataset |
| numberOfFiles | number <double> Total number of lines in filelisting of all OrigDatablocks for this dataset |
| numberOfFilesArchived | number <double> Total number of lines in filelisting of all Datablocks for this dataset |
| creationTime required | string <date-time> Time when dataset became fully available on disk, i.e. all containing files have been written. Format according to chapter 5.6 internet date/time format in RFC 3339. Local times without timezone/offset info are automatically transformed to UTC using the timezone of the API server. |
| type required | string Characterize type of dataset, either 'base' or 'raw' or 'derived'. Autofilled when choosing the proper inherited models |
| validationStatus | string Defines a level of trust, e.g. a measure of how much data was verified or used by other persons |
| keywords | Array of strings Array of tags associated with the meaning or contents of this dataset. Values should ideally come from defined vocabularies, taxonomies, ontologies or knowledge graphs |
| description | string Free text explanation of contents of dataset |
| datasetName | string A name for the dataset, given by the creator to carry some semantic meaning. Useful for display purposes e.g. instead of displaying the pid. Will be autofilled if missing using info from sourceFolder |
| classification | string ACIA information about AUthenticity,COnfidentiality,INtegrity and AVailability requirements of dataset. E.g. AV(ailabilty)=medium could trigger the creation of a two tape copies. Format 'AV=medium,CO=low' |
| license | string Name of license under which data can be used |
| version | string Version of API used in creation of dataset |
| isPublished | boolean Flag is true when data are made publically available |
| ownerGroup required | string Defines the group which owns the data, and therefore has unrestricted access to this data. Usually a pgroup like p12151 |
| accessGroups | Array of strings Optional additional groups which have read access to the data. Users which are member in one of the groups listed here are allowed to access this data. The special group 'public' makes data available to all users |
| createdBy | string Functional or user account name who created this instance |
| updatedBy | string Functional or user account name who last updated this instance |
| createdAt | string <date-time> |
| updatedAt | string <date-time> |
| publisheddataId | string |
object (DatasetLifecycle) For each dataset there exists an embedded dataset lifecycle document which describes the current status of the dataset during its lifetime with respect to the storage handling systems | |
Array of objects (Message) | |
| instrumentId | string |
Array of objects (Technique) |
{- "investigator": "string",
- "inputDatasets": [
- "string"
], - "usedSoftware": [
- "string"
], - "jobParameters": { },
- "jobLogData": "string",
- "scientificMetadata": { },
- "pid": "string",
- "owner": "string",
- "ownerEmail": "string",
- "orcidOfOwner": "string",
- "contactEmail": "string",
- "sourceFolder": "string",
- "sourceFolderHost": "string",
- "size": 0,
- "packedSize": 0,
- "numberOfFiles": 0,
- "numberOfFilesArchived": 0,
- "creationTime": "2019-08-24T14:15:22Z",
- "type": "string",
- "validationStatus": "string",
- "keywords": [
- "string"
], - "description": "string",
- "datasetName": "string",
- "classification": "string",
- "license": "string",
- "version": "string",
- "isPublished": true,
- "ownerGroup": "string",
- "accessGroups": [
- "string"
], - "createdBy": "string",
- "updatedBy": "string",
- "createdAt": "2019-08-24T14:15:22Z",
- "updatedAt": "2019-08-24T14:15:22Z",
- "publisheddataId": "string",
- "datasetlifecycle": {
- "archivable": true,
- "retrievable": true,
- "publishable": true,
- "dateOfDiskPurging": "2019-08-24T14:15:22Z",
- "archiveRetentionTime": "2019-08-24T14:15:22Z",
- "dateOfPublishing": "2019-08-24T14:15:22Z",
- "isOnCentralDisk": true,
- "archiveStatusMessage": "string",
- "retrieveStatusMessage": "string",
- "archiveReturnMessage": { },
- "retrieveReturnMessage": { },
- "exportedTo": "string",
- "retrieveIntegrityCheck": true,
- "id": "string"
}, - "history": [
- {
- "id": "string"
}
], - "instrumentId": "string",
- "techniques": [
- {
- "pid": "string",
- "name": "string"
}
]
}{- "investigator": "string",
- "inputDatasets": [
- "string"
], - "usedSoftware": [
- "string"
], - "jobParameters": { },
- "jobLogData": "string",
- "scientificMetadata": { },
- "pid": "string",
- "owner": "string",
- "ownerEmail": "string",
- "orcidOfOwner": "string",
- "contactEmail": "string",
- "sourceFolder": "string",
- "sourceFolderHost": "string",
- "size": 0,
- "packedSize": 0,
- "numberOfFiles": 0,
- "numberOfFilesArchived": 0,
- "creationTime": "2019-08-24T14:15:22Z",
- "type": "string",
- "validationStatus": "string",
- "keywords": [
- "string"
], - "description": "string",
- "datasetName": "string",
- "classification": "string",
- "license": "string",
- "version": "string",
- "isPublished": true,
- "ownerGroup": "string",
- "accessGroups": [
- "string"
], - "createdBy": "string",
- "updatedBy": "string",
- "createdAt": "2019-08-24T14:15:22Z",
- "updatedAt": "2019-08-24T14:15:22Z",
- "publisheddataId": "string",
- "datasetlifecycle": {
- "archivable": true,
- "retrievable": true,
- "publishable": true,
- "dateOfDiskPurging": "2019-08-24T14:15:22Z",
- "archiveRetentionTime": "2019-08-24T14:15:22Z",
- "dateOfPublishing": "2019-08-24T14:15:22Z",
- "isOnCentralDisk": true,
- "archiveStatusMessage": "string",
- "retrieveStatusMessage": "string",
- "archiveReturnMessage": { },
- "retrieveReturnMessage": { },
- "exportedTo": "string",
- "retrieveIntegrityCheck": true,
- "id": "string"
}, - "history": [
- {
- "id": "string"
}
], - "instrumentId": "string",
- "techniques": [
- {
- "pid": "string",
- "name": "string"
}
]
}| id required | string <JSON> DerivedDataset id |
An object of model property name/value pairs
| investigator required | string Email of person pursuing the data analysis |
| inputDatasets required | Array of strings Array of input dataset identifiers used in producing the derived dataset. Ideally these are the global identifier to existing datasets inside this or federated data catalogs |
| usedSoftware required | Array of strings A list of links to software repositories which uniquely identifies the software used and the version for yielding the derived data |
| jobParameters | object The creation process of the drived data will usually depend on input job parameters. The full structure of these input parameters are stored here |
| jobLogData | string The output job logfile. Keep the size of this log data well below 15 MB |
| scientificMetadata | object JSON object containing the scientific meta data |
| pid required | string Persistent Identifier for datasets derived from UUIDv4 and prepended automatically by site specific PID prefix like 20.500.12345/ |
| owner required | string Owner of the data set, usually first name + lastname |
| ownerEmail | string Email of owner of the data set |
| orcidOfOwner | string ORCID of owner https://orcid.org if available |
| contactEmail required | string Email of contact person for this dataset |
| sourceFolder required | string Absolute file path on file server containing the files of this dataset, e.g. /some/path/to/sourcefolder. In case of a single file dataset, e.g. HDF5 data, it contains the path up to, but excluding the filename. Trailing slashes are removed. |
| sourceFolderHost | string DNS host name of file server hosting sourceFolder, optionally including protocol e.g. [protocol://]fileserver1.example.com |
| size | number <double> Total size of all source files contained in source folder on disk when unpacked |
| packedSize | number <double> Total size of all datablock package files created for this dataset |
| numberOfFiles | number <double> Total number of lines in filelisting of all OrigDatablocks for this dataset |
| numberOfFilesArchived | number <double> Total number of lines in filelisting of all Datablocks for this dataset |
| creationTime required | string <date-time> Time when dataset became fully available on disk, i.e. all containing files have been written. Format according to chapter 5.6 internet date/time format in RFC 3339. Local times without timezone/offset info are automatically transformed to UTC using the timezone of the API server. |
| type required | string Characterize type of dataset, either 'base' or 'raw' or 'derived'. Autofilled when choosing the proper inherited models |
| validationStatus | string Defines a level of trust, e.g. a measure of how much data was verified or used by other persons |
| keywords | Array of strings Array of tags associated with the meaning or contents of this dataset. Values should ideally come from defined vocabularies, taxonomies, ontologies or knowledge graphs |
| description | string Free text explanation of contents of dataset |
| datasetName | string A name for the dataset, given by the creator to carry some semantic meaning. Useful for display purposes e.g. instead of displaying the pid. Will be autofilled if missing using info from sourceFolder |
| classification | string ACIA information about AUthenticity,COnfidentiality,INtegrity and AVailability requirements of dataset. E.g. AV(ailabilty)=medium could trigger the creation of a two tape copies. Format 'AV=medium,CO=low' |
| license | string Name of license under which data can be used |
| version | string Version of API used in creation of dataset |
| isPublished | boolean Flag is true when data are made publically available |
| ownerGroup required | string Defines the group which owns the data, and therefore has unrestricted access to this data. Usually a pgroup like p12151 |
| accessGroups | Array of strings Optional additional groups which have read access to the data. Users which are member in one of the groups listed here are allowed to access this data. The special group 'public' makes data available to all users |
| createdBy | string Functional or user account name who created this instance |
| updatedBy | string Functional or user account name who last updated this instance |
| createdAt | string <date-time> |
| updatedAt | string <date-time> |
| publisheddataId | string |
object (DatasetLifecycle) For each dataset there exists an embedded dataset lifecycle document which describes the current status of the dataset during its lifetime with respect to the storage handling systems | |
Array of objects (Message) | |
| instrumentId | string |
Array of objects (Technique) |
{- "investigator": "string",
- "inputDatasets": [
- "string"
], - "usedSoftware": [
- "string"
], - "jobParameters": { },
- "jobLogData": "string",
- "scientificMetadata": { },
- "pid": "string",
- "owner": "string",
- "ownerEmail": "string",
- "orcidOfOwner": "string",
- "contactEmail": "string",
- "sourceFolder": "string",
- "sourceFolderHost": "string",
- "size": 0,
- "packedSize": 0,
- "numberOfFiles": 0,
- "numberOfFilesArchived": 0,
- "creationTime": "2019-08-24T14:15:22Z",
- "type": "string",
- "validationStatus": "string",
- "keywords": [
- "string"
], - "description": "string",
- "datasetName": "string",
- "classification": "string",
- "license": "string",
- "version": "string",
- "isPublished": true,
- "ownerGroup": "string",
- "accessGroups": [
- "string"
], - "createdBy": "string",
- "updatedBy": "string",
- "createdAt": "2019-08-24T14:15:22Z",
- "updatedAt": "2019-08-24T14:15:22Z",
- "publisheddataId": "string",
- "datasetlifecycle": {
- "archivable": true,
- "retrievable": true,
- "publishable": true,
- "dateOfDiskPurging": "2019-08-24T14:15:22Z",
- "archiveRetentionTime": "2019-08-24T14:15:22Z",
- "dateOfPublishing": "2019-08-24T14:15:22Z",
- "isOnCentralDisk": true,
- "archiveStatusMessage": "string",
- "retrieveStatusMessage": "string",
- "archiveReturnMessage": { },
- "retrieveReturnMessage": { },
- "exportedTo": "string",
- "retrieveIntegrityCheck": true,
- "id": "string"
}, - "history": [
- {
- "id": "string"
}
], - "instrumentId": "string",
- "techniques": [
- {
- "pid": "string",
- "name": "string"
}
]
}{- "investigator": "string",
- "inputDatasets": [
- "string"
], - "usedSoftware": [
- "string"
], - "jobParameters": { },
- "jobLogData": "string",
- "scientificMetadata": { },
- "pid": "string",
- "owner": "string",
- "ownerEmail": "string",
- "orcidOfOwner": "string",
- "contactEmail": "string",
- "sourceFolder": "string",
- "sourceFolderHost": "string",
- "size": 0,
- "packedSize": 0,
- "numberOfFiles": 0,
- "numberOfFilesArchived": 0,
- "creationTime": "2019-08-24T14:15:22Z",
- "type": "string",
- "validationStatus": "string",
- "keywords": [
- "string"
], - "description": "string",
- "datasetName": "string",
- "classification": "string",
- "license": "string",
- "version": "string",
- "isPublished": true,
- "ownerGroup": "string",
- "accessGroups": [
- "string"
], - "createdBy": "string",
- "updatedBy": "string",
- "createdAt": "2019-08-24T14:15:22Z",
- "updatedAt": "2019-08-24T14:15:22Z",
- "publisheddataId": "string",
- "datasetlifecycle": {
- "archivable": true,
- "retrievable": true,
- "publishable": true,
- "dateOfDiskPurging": "2019-08-24T14:15:22Z",
- "archiveRetentionTime": "2019-08-24T14:15:22Z",
- "dateOfPublishing": "2019-08-24T14:15:22Z",
- "isOnCentralDisk": true,
- "archiveStatusMessage": "string",
- "retrieveStatusMessage": "string",
- "archiveReturnMessage": { },
- "retrieveReturnMessage": { },
- "exportedTo": "string",
- "retrieveIntegrityCheck": true,
- "id": "string"
}, - "history": [
- {
- "id": "string"
}
], - "instrumentId": "string",
- "techniques": [
- {
- "pid": "string",
- "name": "string"
}
]
}| id required | string <JSON> Model id |
Model instance data
| investigator required | string Email of person pursuing the data analysis |
| inputDatasets required | Array of strings Array of input dataset identifiers used in producing the derived dataset. Ideally these are the global identifier to existing datasets inside this or federated data catalogs |
| usedSoftware required | Array of strings A list of links to software repositories which uniquely identifies the software used and the version for yielding the derived data |
| jobParameters | object The creation process of the drived data will usually depend on input job parameters. The full structure of these input parameters are stored here |
| jobLogData | string The output job logfile. Keep the size of this log data well below 15 MB |
| scientificMetadata | object JSON object containing the scientific meta data |
| pid required | string Persistent Identifier for datasets derived from UUIDv4 and prepended automatically by site specific PID prefix like 20.500.12345/ |
| owner required | string Owner of the data set, usually first name + lastname |
| ownerEmail | string Email of owner of the data set |
| orcidOfOwner | string ORCID of owner https://orcid.org if available |
| contactEmail required | string Email of contact person for this dataset |
| sourceFolder required | string Absolute file path on file server containing the files of this dataset, e.g. /some/path/to/sourcefolder. In case of a single file dataset, e.g. HDF5 data, it contains the path up to, but excluding the filename. Trailing slashes are removed. |
| sourceFolderHost | string DNS host name of file server hosting sourceFolder, optionally including protocol e.g. [protocol://]fileserver1.example.com |
| size | number <double> Total size of all source files contained in source folder on disk when unpacked |
| packedSize | number <double> Total size of all datablock package files created for this dataset |
| numberOfFiles | number <double> Total number of lines in filelisting of all OrigDatablocks for this dataset |
| numberOfFilesArchived | number <double> Total number of lines in filelisting of all Datablocks for this dataset |
| creationTime required | string <date-time> Time when dataset became fully available on disk, i.e. all containing files have been written. Format according to chapter 5.6 internet date/time format in RFC 3339. Local times without timezone/offset info are automatically transformed to UTC using the timezone of the API server. |
| type required | string Characterize type of dataset, either 'base' or 'raw' or 'derived'. Autofilled when choosing the proper inherited models |
| validationStatus | string Defines a level of trust, e.g. a measure of how much data was verified or used by other persons |
| keywords | Array of strings Array of tags associated with the meaning or contents of this dataset. Values should ideally come from defined vocabularies, taxonomies, ontologies or knowledge graphs |
| description | string Free text explanation of contents of dataset |
| datasetName | string A name for the dataset, given by the creator to carry some semantic meaning. Useful for display purposes e.g. instead of displaying the pid. Will be autofilled if missing using info from sourceFolder |
| classification | string ACIA information about AUthenticity,COnfidentiality,INtegrity and AVailability requirements of dataset. E.g. AV(ailabilty)=medium could trigger the creation of a two tape copies. Format 'AV=medium,CO=low' |
| license | string Name of license under which data can be used |
| version | string Version of API used in creation of dataset |
| isPublished | boolean Flag is true when data are made publically available |
| ownerGroup required | string Defines the group which owns the data, and therefore has unrestricted access to this data. Usually a pgroup like p12151 |
| accessGroups | Array of strings Optional additional groups which have read access to the data. Users which are member in one of the groups listed here are allowed to access this data. The special group 'public' makes data available to all users |
| createdBy | string Functional or user account name who created this instance |
| updatedBy | string Functional or user account name who last updated this instance |
| createdAt | string <date-time> |
| updatedAt | string <date-time> |
| publisheddataId | string |
object (DatasetLifecycle) For each dataset there exists an embedded dataset lifecycle document which describes the current status of the dataset during its lifetime with respect to the storage handling systems | |
Array of objects (Message) | |
| instrumentId | string |
Array of objects (Technique) |
{- "investigator": "string",
- "inputDatasets": [
- "string"
], - "usedSoftware": [
- "string"
], - "jobParameters": { },
- "jobLogData": "string",
- "scientificMetadata": { },
- "pid": "string",
- "owner": "string",
- "ownerEmail": "string",
- "orcidOfOwner": "string",
- "contactEmail": "string",
- "sourceFolder": "string",
- "sourceFolderHost": "string",
- "size": 0,
- "packedSize": 0,
- "numberOfFiles": 0,
- "numberOfFilesArchived": 0,
- "creationTime": "2019-08-24T14:15:22Z",
- "type": "string",
- "validationStatus": "string",
- "keywords": [
- "string"
], - "description": "string",
- "datasetName": "string",
- "classification": "string",
- "license": "string",
- "version": "string",
- "isPublished": true,
- "ownerGroup": "string",
- "accessGroups": [
- "string"
], - "createdBy": "string",
- "updatedBy": "string",
- "createdAt": "2019-08-24T14:15:22Z",
- "updatedAt": "2019-08-24T14:15:22Z",
- "publisheddataId": "string",
- "datasetlifecycle": {
- "archivable": true,
- "retrievable": true,
- "publishable": true,
- "dateOfDiskPurging": "2019-08-24T14:15:22Z",
- "archiveRetentionTime": "2019-08-24T14:15:22Z",
- "dateOfPublishing": "2019-08-24T14:15:22Z",
- "isOnCentralDisk": true,
- "archiveStatusMessage": "string",
- "retrieveStatusMessage": "string",
- "archiveReturnMessage": { },
- "retrieveReturnMessage": { },
- "exportedTo": "string",
- "retrieveIntegrityCheck": true,
- "id": "string"
}, - "history": [
- {
- "id": "string"
}
], - "instrumentId": "string",
- "techniques": [
- {
- "pid": "string",
- "name": "string"
}
]
}{- "investigator": "string",
- "inputDatasets": [
- "string"
], - "usedSoftware": [
- "string"
], - "jobParameters": { },
- "jobLogData": "string",
- "scientificMetadata": { },
- "pid": "string",
- "owner": "string",
- "ownerEmail": "string",
- "orcidOfOwner": "string",
- "contactEmail": "string",
- "sourceFolder": "string",
- "sourceFolderHost": "string",
- "size": 0,
- "packedSize": 0,
- "numberOfFiles": 0,
- "numberOfFilesArchived": 0,
- "creationTime": "2019-08-24T14:15:22Z",
- "type": "string",
- "validationStatus": "string",
- "keywords": [
- "string"
], - "description": "string",
- "datasetName": "string",
- "classification": "string",
- "license": "string",
- "version": "string",
- "isPublished": true,
- "ownerGroup": "string",
- "accessGroups": [
- "string"
], - "createdBy": "string",
- "updatedBy": "string",
- "createdAt": "2019-08-24T14:15:22Z",
- "updatedAt": "2019-08-24T14:15:22Z",
- "publisheddataId": "string",
- "datasetlifecycle": {
- "archivable": true,
- "retrievable": true,
- "publishable": true,
- "dateOfDiskPurging": "2019-08-24T14:15:22Z",
- "archiveRetentionTime": "2019-08-24T14:15:22Z",
- "dateOfPublishing": "2019-08-24T14:15:22Z",
- "isOnCentralDisk": true,
- "archiveStatusMessage": "string",
- "retrieveStatusMessage": "string",
- "archiveReturnMessage": { },
- "retrieveReturnMessage": { },
- "exportedTo": "string",
- "retrieveIntegrityCheck": true,
- "id": "string"
}, - "history": [
- {
- "id": "string"
}
], - "instrumentId": "string",
- "techniques": [
- {
- "pid": "string",
- "name": "string"
}
]
}| filter | string <JSON> Filter defining fields, where, include, order, offset, and limit - must be a JSON-encoded string ( |
{- "investigator": "string",
- "inputDatasets": [
- "string"
], - "usedSoftware": [
- "string"
], - "jobParameters": { },
- "jobLogData": "string",
- "scientificMetadata": { },
- "pid": "string",
- "owner": "string",
- "ownerEmail": "string",
- "orcidOfOwner": "string",
- "contactEmail": "string",
- "sourceFolder": "string",
- "sourceFolderHost": "string",
- "size": 0,
- "packedSize": 0,
- "numberOfFiles": 0,
- "numberOfFilesArchived": 0,
- "creationTime": "2019-08-24T14:15:22Z",
- "type": "string",
- "validationStatus": "string",
- "keywords": [
- "string"
], - "description": "string",
- "datasetName": "string",
- "classification": "string",
- "license": "string",
- "version": "string",
- "isPublished": true,
- "ownerGroup": "string",
- "accessGroups": [
- "string"
], - "createdBy": "string",
- "updatedBy": "string",
- "createdAt": "2019-08-24T14:15:22Z",
- "updatedAt": "2019-08-24T14:15:22Z",
- "publisheddataId": "string",
- "datasetlifecycle": {
- "archivable": true,
- "retrievable": true,
- "publishable": true,
- "dateOfDiskPurging": "2019-08-24T14:15:22Z",
- "archiveRetentionTime": "2019-08-24T14:15:22Z",
- "dateOfPublishing": "2019-08-24T14:15:22Z",
- "isOnCentralDisk": true,
- "archiveStatusMessage": "string",
- "retrieveStatusMessage": "string",
- "archiveReturnMessage": { },
- "retrieveReturnMessage": { },
- "exportedTo": "string",
- "retrieveIntegrityCheck": true,
- "id": "string"
}, - "history": [
- {
- "id": "string"
}
], - "instrumentId": "string",
- "techniques": [
- {
- "pid": "string",
- "name": "string"
}
]
}| where | string <JSON> Criteria to match model instances |
An object of model property name/value pairs
| investigator required | string Email of person pursuing the data analysis |
| inputDatasets required | Array of strings Array of input dataset identifiers used in producing the derived dataset. Ideally these are the global identifier to existing datasets inside this or federated data catalogs |
| usedSoftware required | Array of strings A list of links to software repositories which uniquely identifies the software used and the version for yielding the derived data |
| jobParameters | object The creation process of the drived data will usually depend on input job parameters. The full structure of these input parameters are stored here |
| jobLogData | string The output job logfile. Keep the size of this log data well below 15 MB |
| scientificMetadata | object JSON object containing the scientific meta data |
| pid required | string Persistent Identifier for datasets derived from UUIDv4 and prepended automatically by site specific PID prefix like 20.500.12345/ |
| owner required | string Owner of the data set, usually first name + lastname |
| ownerEmail | string Email of owner of the data set |
| orcidOfOwner | string ORCID of owner https://orcid.org if available |
| contactEmail required | string Email of contact person for this dataset |
| sourceFolder required | string Absolute file path on file server containing the files of this dataset, e.g. /some/path/to/sourcefolder. In case of a single file dataset, e.g. HDF5 data, it contains the path up to, but excluding the filename. Trailing slashes are removed. |
| sourceFolderHost | string DNS host name of file server hosting sourceFolder, optionally including protocol e.g. [protocol://]fileserver1.example.com |
| size | number <double> Total size of all source files contained in source folder on disk when unpacked |
| packedSize | number <double> Total size of all datablock package files created for this dataset |
| numberOfFiles | number <double> Total number of lines in filelisting of all OrigDatablocks for this dataset |
| numberOfFilesArchived | number <double> Total number of lines in filelisting of all Datablocks for this dataset |
| creationTime required | string <date-time> Time when dataset became fully available on disk, i.e. all containing files have been written. Format according to chapter 5.6 internet date/time format in RFC 3339. Local times without timezone/offset info are automatically transformed to UTC using the timezone of the API server. |
| type required | string Characterize type of dataset, either 'base' or 'raw' or 'derived'. Autofilled when choosing the proper inherited models |
| validationStatus | string Defines a level of trust, e.g. a measure of how much data was verified or used by other persons |
| keywords | Array of strings Array of tags associated with the meaning or contents of this dataset. Values should ideally come from defined vocabularies, taxonomies, ontologies or knowledge graphs |
| description | string Free text explanation of contents of dataset |
| datasetName | string A name for the dataset, given by the creator to carry some semantic meaning. Useful for display purposes e.g. instead of displaying the pid. Will be autofilled if missing using info from sourceFolder |
| classification | string ACIA information about AUthenticity,COnfidentiality,INtegrity and AVailability requirements of dataset. E.g. AV(ailabilty)=medium could trigger the creation of a two tape copies. Format 'AV=medium,CO=low' |
| license | string Name of license under which data can be used |
| version | string Version of API used in creation of dataset |
| isPublished | boolean Flag is true when data are made publically available |
| ownerGroup required | string Defines the group which owns the data, and therefore has unrestricted access to this data. Usually a pgroup like p12151 |
| accessGroups | Array of strings Optional additional groups which have read access to the data. Users which are member in one of the groups listed here are allowed to access this data. The special group 'public' makes data available to all users |
| createdBy | string Functional or user account name who created this instance |
| updatedBy | string Functional or user account name who last updated this instance |
| createdAt | string <date-time> |
| updatedAt | string <date-time> |
| publisheddataId | string |
object (DatasetLifecycle) For each dataset there exists an embedded dataset lifecycle document which describes the current status of the dataset during its lifetime with respect to the storage handling systems | |
Array of objects (Message) | |
| instrumentId | string |
Array of objects (Technique) |
{- "investigator": "string",
- "inputDatasets": [
- "string"
], - "usedSoftware": [
- "string"
], - "jobParameters": { },
- "jobLogData": "string",
- "scientificMetadata": { },
- "pid": "string",
- "owner": "string",
- "ownerEmail": "string",
- "orcidOfOwner": "string",
- "contactEmail": "string",
- "sourceFolder": "string",
- "sourceFolderHost": "string",
- "size": 0,
- "packedSize": 0,
- "numberOfFiles": 0,
- "numberOfFilesArchived": 0,
- "creationTime": "2019-08-24T14:15:22Z",
- "type": "string",
- "validationStatus": "string",
- "keywords": [
- "string"
], - "description": "string",
- "datasetName": "string",
- "classification": "string",
- "license": "string",
- "version": "string",
- "isPublished": true,
- "ownerGroup": "string",
- "accessGroups": [
- "string"
], - "createdBy": "string",
- "updatedBy": "string",
- "createdAt": "2019-08-24T14:15:22Z",
- "updatedAt": "2019-08-24T14:15:22Z",
- "publisheddataId": "string",
- "datasetlifecycle": {
- "archivable": true,
- "retrievable": true,
- "publishable": true,
- "dateOfDiskPurging": "2019-08-24T14:15:22Z",
- "archiveRetentionTime": "2019-08-24T14:15:22Z",
- "dateOfPublishing": "2019-08-24T14:15:22Z",
- "isOnCentralDisk": true,
- "archiveStatusMessage": "string",
- "retrieveStatusMessage": "string",
- "archiveReturnMessage": { },
- "retrieveReturnMessage": { },
- "exportedTo": "string",
- "retrieveIntegrityCheck": true,
- "id": "string"
}, - "history": [
- {
- "id": "string"
}
], - "instrumentId": "string",
- "techniques": [
- {
- "pid": "string",
- "name": "string"
}
]
}{- "count": 0
}{ }{ }| datasetId | string |
{ }| fields | string <JSON> Define the filter conditions by specifying the name and values of fields. There ia also support for a |
| facets | string <JSON> Defines list of field names, for which facet counts should be calculated |
{ }| fields | string <JSON> Define the filter conditions by specifying the name of values of fields requested. There ia also support for a |
| limits | string <JSON> Define further query parameters like skip, limit, order |
{ }| fields | string <JSON> Define the filter conditions by specifying the name of values of fields requested. There ia also support for a |
| limits | string <JSON> Define further query parameters like skip, limit, order |
{ }Models describing the characteristics of the samples to be investigated. Raw datasets should be linked to such sample definitions.
| id required | string <JSON> Sample id |
| refresh | boolean |
{- "pid": "string",
- "owner": "string",
- "ownerEmail": "string",
- "orcidOfOwner": "string",
- "contactEmail": "string",
- "sourceFolder": "string",
- "sourceFolderHost": "string",
- "size": 0,
- "packedSize": 0,
- "numberOfFiles": 0,
- "numberOfFilesArchived": 0,
- "creationTime": "2019-08-24T14:15:22Z",
- "type": "string",
- "validationStatus": "string",
- "keywords": [
- "string"
], - "description": "string",
- "datasetName": "string",
- "classification": "string",
- "license": "string",
- "version": "string",
- "isPublished": true,
- "ownerGroup": "string",
- "accessGroups": [
- "string"
], - "createdBy": "string",
- "updatedBy": "string",
- "createdAt": "2019-08-24T14:15:22Z",
- "updatedAt": "2019-08-24T14:15:22Z",
- "publishedDataId": "string",
- "publisheddataId": "string",
- "datasetlifecycle": {
- "archivable": true,
- "retrievable": true,
- "publishable": true,
- "dateOfDiskPurging": "2019-08-24T14:15:22Z",
- "archiveRetentionTime": "2019-08-24T14:15:22Z",
- "dateOfPublishing": "2019-08-24T14:15:22Z",
- "isOnCentralDisk": true,
- "archiveStatusMessage": "string",
- "retrieveStatusMessage": "string",
- "archiveReturnMessage": { },
- "retrieveReturnMessage": { },
- "exportedTo": "string",
- "retrieveIntegrityCheck": true,
- "id": "string"
}, - "history": [
- {
- "id": "string"
}
], - "instrumentId": "string",
- "techniques": [
- {
- "pid": "string",
- "name": "string"
}
]
}| id required | string <JSON> Sample id |
| fk required | string <JSON> Foreign key for attachments |
{- "thumbnail": "retrieve",
- "caption": "",
- "ownerGroup": "string",
- "accessGroups": [
- "string"
], - "createdBy": "string",
- "updatedBy": "string",
- "id": "string",
- "datasetId": "string",
- "sampleId": "string",
- "proposalId": "string",
- "rawDatasetId": "string",
- "derivedDatasetId": "string",
- "createdAt": "2019-08-24T14:15:22Z",
- "updatedAt": "2019-08-24T14:15:22Z"
}| id required | string <JSON> Sample id |
| fk required | string <JSON> Foreign key for attachments |
| thumbnail required | string Default: "retrieve" Contains a thumbnail preview in base64 encoded png format for a given dataset |
| caption | string Default: "" Attachment caption to show in catanie |
| ownerGroup required | string Defines the group which owns the data, and therefore has unrestricted access to this data. Usually a pgroup like p12151 |
| accessGroups | Array of strings Optional additional groups which have read access to the data. Users which are member in one of the groups listed here are allowed to access this data. The special group 'public' makes data available to all users |
| createdBy | string Functional or user account name who created this instance |
| updatedBy | string Functional or user account name who last updated this instance |
| id | string (ObjectID) ^[a-fA-F\d]{24}$ |
| datasetId | string |
| sampleId | string |
| proposalId | string |
| rawDatasetId | string |
| derivedDatasetId | string |
| createdAt | string <date-time> |
| updatedAt | string <date-time> |
{- "thumbnail": "retrieve",
- "caption": "",
- "ownerGroup": "string",
- "accessGroups": [
- "string"
], - "createdBy": "string",
- "updatedBy": "string",
- "id": "string",
- "datasetId": "string",
- "sampleId": "string",
- "proposalId": "string",
- "rawDatasetId": "string",
- "derivedDatasetId": "string",
- "createdAt": "2019-08-24T14:15:22Z",
- "updatedAt": "2019-08-24T14:15:22Z"
}{- "thumbnail": "retrieve",
- "caption": "",
- "ownerGroup": "string",
- "accessGroups": [
- "string"
], - "createdBy": "string",
- "updatedBy": "string",
- "id": "string",
- "datasetId": "string",
- "sampleId": "string",
- "proposalId": "string",
- "rawDatasetId": "string",
- "derivedDatasetId": "string",
- "createdAt": "2019-08-24T14:15:22Z",
- "updatedAt": "2019-08-24T14:15:22Z"
}| id required | string <JSON> Sample id |
| filter | string <JSON> |
[- {
- "thumbnail": "retrieve",
- "caption": "",
- "ownerGroup": "string",
- "accessGroups": [
- "string"
], - "createdBy": "string",
- "updatedBy": "string",
- "id": "string",
- "datasetId": "string",
- "sampleId": "string",
- "proposalId": "string",
- "rawDatasetId": "string",
- "derivedDatasetId": "string",
- "createdAt": "2019-08-24T14:15:22Z",
- "updatedAt": "2019-08-24T14:15:22Z"
}
]| id required | string <JSON> Sample id |
| thumbnail required | string Default: "retrieve" Contains a thumbnail preview in base64 encoded png format for a given dataset |
| caption | string Default: "" Attachment caption to show in catanie |
| ownerGroup required | string Defines the group which owns the data, and therefore has unrestricted access to this data. Usually a pgroup like p12151 |
| accessGroups | Array of strings Optional additional groups which have read access to the data. Users which are member in one of the groups listed here are allowed to access this data. The special group 'public' makes data available to all users |
| createdBy | string Functional or user account name who created this instance |
| updatedBy | string Functional or user account name who last updated this instance |
| id | string (ObjectID) ^[a-fA-F\d]{24}$ |
| datasetId | string |
| sampleId | string |
| proposalId | string |
| rawDatasetId | string |
| derivedDatasetId | string |
| createdAt | string <date-time> |
| updatedAt | string <date-time> |
{- "thumbnail": "retrieve",
- "caption": "",
- "ownerGroup": "string",
- "accessGroups": [
- "string"
], - "createdBy": "string",
- "updatedBy": "string",
- "id": "string",
- "datasetId": "string",
- "sampleId": "string",
- "proposalId": "string",
- "rawDatasetId": "string",
- "derivedDatasetId": "string",
- "createdAt": "2019-08-24T14:15:22Z",
- "updatedAt": "2019-08-24T14:15:22Z"
}{- "thumbnail": "retrieve",
- "caption": "",
- "ownerGroup": "string",
- "accessGroups": [
- "string"
], - "createdBy": "string",
- "updatedBy": "string",
- "id": "string",
- "datasetId": "string",
- "sampleId": "string",
- "proposalId": "string",
- "rawDatasetId": "string",
- "derivedDatasetId": "string",
- "createdAt": "2019-08-24T14:15:22Z",
- "updatedAt": "2019-08-24T14:15:22Z"
}Model instance data
| sampleId required | string |
| owner | string |
| description | string |
| createdAt | string <date-time> |
| sampleCharacteristics | object |
| isPublished | boolean Flag is true when data are made publically available |
| ownerGroup required | string Defines the group which owns the data, and therefore has unrestricted access to this data. Usually a pgroup like p12151 |
| accessGroups | Array of strings Optional additional groups which have read access to the data. Users which are member in one of the groups listed here are allowed to access this data. The special group 'public' makes data available to all users |
| createdBy | string Functional or user account name who created this instance |
| updatedBy | string Functional or user account name who last updated this instance |
| datasetsId | string |
| datasetId | string |
| rawDatasetId | string |
| derivedDatasetId | string |
| updatedAt | string <date-time> |
{- "sampleId": "string",
- "owner": "string",
- "description": "string",
- "createdAt": "2019-08-24T14:15:22Z",
- "sampleCharacteristics": { },
- "isPublished": true,
- "ownerGroup": "string",
- "accessGroups": [
- "string"
], - "createdBy": "string",
- "updatedBy": "string",
- "datasetsId": "string",
- "datasetId": "string",
- "rawDatasetId": "string",
- "derivedDatasetId": "string",
- "updatedAt": "2019-08-24T14:15:22Z"
}{- "sampleId": "string",
- "owner": "string",
- "description": "string",
- "createdAt": "2019-08-24T14:15:22Z",
- "sampleCharacteristics": { },
- "isPublished": true,
- "ownerGroup": "string",
- "accessGroups": [
- "string"
], - "createdBy": "string",
- "updatedBy": "string",
- "datasetsId": "string",
- "datasetId": "string",
- "rawDatasetId": "string",
- "derivedDatasetId": "string",
- "updatedAt": "2019-08-24T14:15:22Z"
}Model instance data
| sampleId required | string |
| owner | string |
| description | string |
| createdAt | string <date-time> |
| sampleCharacteristics | object |
| isPublished | boolean Flag is true when data are made publically available |
| ownerGroup required | string Defines the group which owns the data, and therefore has unrestricted access to this data. Usually a pgroup like p12151 |
| accessGroups | Array of strings Optional additional groups which have read access to the data. Users which are member in one of the groups listed here are allowed to access this data. The special group 'public' makes data available to all users |
| createdBy | string Functional or user account name who created this instance |
| updatedBy | string Functional or user account name who last updated this instance |
| datasetsId | string |
| datasetId | string |
| rawDatasetId | string |
| derivedDatasetId | string |
| updatedAt | string <date-time> |
{- "sampleId": "string",
- "owner": "string",
- "description": "string",
- "createdAt": "2019-08-24T14:15:22Z",
- "sampleCharacteristics": { },
- "isPublished": true,
- "ownerGroup": "string",
- "accessGroups": [
- "string"
], - "createdBy": "string",
- "updatedBy": "string",
- "datasetsId": "string",
- "datasetId": "string",
- "rawDatasetId": "string",
- "derivedDatasetId": "string",
- "updatedAt": "2019-08-24T14:15:22Z"
}{- "sampleId": "string",
- "owner": "string",
- "description": "string",
- "createdAt": "2019-08-24T14:15:22Z",
- "sampleCharacteristics": { },
- "isPublished": true,
- "ownerGroup": "string",
- "accessGroups": [
- "string"
], - "createdBy": "string",
- "updatedBy": "string",
- "datasetsId": "string",
- "datasetId": "string",
- "rawDatasetId": "string",
- "derivedDatasetId": "string",
- "updatedAt": "2019-08-24T14:15:22Z"
}Model instance data
| sampleId required | string |
| owner | string |
| description | string |
| createdAt | string <date-time> |
| sampleCharacteristics | object |
| isPublished | boolean Flag is true when data are made publically available |
| ownerGroup required | string Defines the group which owns the data, and therefore has unrestricted access to this data. Usually a pgroup like p12151 |
| accessGroups | Array of strings Optional additional groups which have read access to the data. Users which are member in one of the groups listed here are allowed to access this data. The special group 'public' makes data available to all users |
| createdBy | string Functional or user account name who created this instance |
| updatedBy | string Functional or user account name who last updated this instance |
| datasetsId | string |
| datasetId | string |
| rawDatasetId | string |
| derivedDatasetId | string |
| updatedAt | string <date-time> |
{- "sampleId": "string",
- "owner": "string",
- "description": "string",
- "createdAt": "2019-08-24T14:15:22Z",
- "sampleCharacteristics": { },
- "isPublished": true,
- "ownerGroup": "string",
- "accessGroups": [
- "string"
], - "createdBy": "string",
- "updatedBy": "string",
- "datasetsId": "string",
- "datasetId": "string",
- "rawDatasetId": "string",
- "derivedDatasetId": "string",
- "updatedAt": "2019-08-24T14:15:22Z"
}{- "sampleId": "string",
- "owner": "string",
- "description": "string",
- "createdAt": "2019-08-24T14:15:22Z",
- "sampleCharacteristics": { },
- "isPublished": true,
- "ownerGroup": "string",
- "accessGroups": [
- "string"
], - "createdBy": "string",
- "updatedBy": "string",
- "datasetsId": "string",
- "datasetId": "string",
- "rawDatasetId": "string",
- "derivedDatasetId": "string",
- "updatedAt": "2019-08-24T14:15:22Z"
}| filter | string <JSON> Filter defining fields, where, include, order, offset, and limit - must be a JSON-encoded string ( |
[- {
- "sampleId": "string",
- "owner": "string",
- "description": "string",
- "createdAt": "2019-08-24T14:15:22Z",
- "sampleCharacteristics": { },
- "isPublished": true,
- "ownerGroup": "string",
- "accessGroups": [
- "string"
], - "createdBy": "string",
- "updatedBy": "string",
- "datasetsId": "string",
- "datasetId": "string",
- "rawDatasetId": "string",
- "derivedDatasetId": "string",
- "updatedAt": "2019-08-24T14:15:22Z"
}
]Model instance data
| sampleId required | string |
| owner | string |
| description | string |
| createdAt | string <date-time> |
| sampleCharacteristics | object |
| isPublished | boolean Flag is true when data are made publically available |
| ownerGroup required | string Defines the group which owns the data, and therefore has unrestricted access to this data. Usually a pgroup like p12151 |
| accessGroups | Array of strings Optional additional groups which have read access to the data. Users which are member in one of the groups listed here are allowed to access this data. The special group 'public' makes data available to all users |
| createdBy | string Functional or user account name who created this instance |
| updatedBy | string Functional or user account name who last updated this instance |
| datasetsId | string |
| datasetId | string |
| rawDatasetId | string |
| derivedDatasetId | string |
| updatedAt | string <date-time> |
{- "sampleId": "string",
- "owner": "string",
- "description": "string",
- "createdAt": "2019-08-24T14:15:22Z",
- "sampleCharacteristics": { },
- "isPublished": true,
- "ownerGroup": "string",
- "accessGroups": [
- "string"
], - "createdBy": "string",
- "updatedBy": "string",
- "datasetsId": "string",
- "datasetId": "string",
- "rawDatasetId": "string",
- "derivedDatasetId": "string",
- "updatedAt": "2019-08-24T14:15:22Z"
}{- "sampleId": "string",
- "owner": "string",
- "description": "string",
- "createdAt": "2019-08-24T14:15:22Z",
- "sampleCharacteristics": { },
- "isPublished": true,
- "ownerGroup": "string",
- "accessGroups": [
- "string"
], - "createdBy": "string",
- "updatedBy": "string",
- "datasetsId": "string",
- "datasetId": "string",
- "rawDatasetId": "string",
- "derivedDatasetId": "string",
- "updatedAt": "2019-08-24T14:15:22Z"
}| where | string <JSON> Criteria to match model instances |
An object of model property name/value pairs
| sampleId required | string |
| owner | string |
| description | string |
| createdAt | string <date-time> |
| sampleCharacteristics | object |
| isPublished | boolean Flag is true when data are made publically available |
| ownerGroup required | string Defines the group which owns the data, and therefore has unrestricted access to this data. Usually a pgroup like p12151 |
| accessGroups | Array of strings Optional additional groups which have read access to the data. Users which are member in one of the groups listed here are allowed to access this data. The special group 'public' makes data available to all users |
| createdBy | string Functional or user account name who created this instance |
| updatedBy | string Functional or user account name who last updated this instance |
| datasetsId | string |
| datasetId | string |
| rawDatasetId | string |
| derivedDatasetId | string |
| updatedAt | string <date-time> |
{- "sampleId": "string",
- "owner": "string",
- "description": "string",
- "createdAt": "2019-08-24T14:15:22Z",
- "sampleCharacteristics": { },
- "isPublished": true,
- "ownerGroup": "string",
- "accessGroups": [
- "string"
], - "createdBy": "string",
- "updatedBy": "string",
- "datasetsId": "string",
- "datasetId": "string",
- "rawDatasetId": "string",
- "derivedDatasetId": "string",
- "updatedAt": "2019-08-24T14:15:22Z"
}{- "sampleId": "string",
- "owner": "string",
- "description": "string",
- "createdAt": "2019-08-24T14:15:22Z",
- "sampleCharacteristics": { },
- "isPublished": true,
- "ownerGroup": "string",
- "accessGroups": [
- "string"
], - "createdBy": "string",
- "updatedBy": "string",
- "datasetsId": "string",
- "datasetId": "string",
- "rawDatasetId": "string",
- "derivedDatasetId": "string",
- "updatedAt": "2019-08-24T14:15:22Z"
}| id required | string <JSON> Model id |
| filter | string <JSON> Filter defining fields and include - must be a JSON-encoded string ({"something":"value"}) |
{- "sampleId": "string",
- "owner": "string",
- "description": "string",
- "createdAt": "2019-08-24T14:15:22Z",
- "sampleCharacteristics": { },
- "isPublished": true,
- "ownerGroup": "string",
- "accessGroups": [
- "string"
], - "createdBy": "string",
- "updatedBy": "string",
- "datasetsId": "string",
- "datasetId": "string",
- "rawDatasetId": "string",
- "derivedDatasetId": "string",
- "updatedAt": "2019-08-24T14:15:22Z"
}| id required | string <JSON> Model id |
Model instance data
| sampleId required | string |
| owner | string |
| description | string |
| createdAt | string <date-time> |
| sampleCharacteristics | object |
| isPublished | boolean Flag is true when data are made publically available |
| ownerGroup required | string Defines the group which owns the data, and therefore has unrestricted access to this data. Usually a pgroup like p12151 |
| accessGroups | Array of strings Optional additional groups which have read access to the data. Users which are member in one of the groups listed here are allowed to access this data. The special group 'public' makes data available to all users |
| createdBy | string Functional or user account name who created this instance |
| updatedBy | string Functional or user account name who last updated this instance |
| datasetsId | string |
| datasetId | string |
| rawDatasetId | string |
| derivedDatasetId | string |
| updatedAt | string <date-time> |
{- "sampleId": "string",
- "owner": "string",
- "description": "string",
- "createdAt": "2019-08-24T14:15:22Z",
- "sampleCharacteristics": { },
- "isPublished": true,
- "ownerGroup": "string",
- "accessGroups": [
- "string"
], - "createdBy": "string",
- "updatedBy": "string",
- "datasetsId": "string",
- "datasetId": "string",
- "rawDatasetId": "string",
- "derivedDatasetId": "string",
- "updatedAt": "2019-08-24T14:15:22Z"
}{- "sampleId": "string",
- "owner": "string",
- "description": "string",
- "createdAt": "2019-08-24T14:15:22Z",
- "sampleCharacteristics": { },
- "isPublished": true,
- "ownerGroup": "string",
- "accessGroups": [
- "string"
], - "createdBy": "string",
- "updatedBy": "string",
- "datasetsId": "string",
- "datasetId": "string",
- "rawDatasetId": "string",
- "derivedDatasetId": "string",
- "updatedAt": "2019-08-24T14:15:22Z"
}| id required | string <JSON> Sample id |
An object of model property name/value pairs
| sampleId required | string |
| owner | string |
| description | string |
| createdAt | string <date-time> |
| sampleCharacteristics | object |
| isPublished | boolean Flag is true when data are made publically available |
| ownerGroup required | string Defines the group which owns the data, and therefore has unrestricted access to this data. Usually a pgroup like p12151 |
| accessGroups | Array of strings Optional additional groups which have read access to the data. Users which are member in one of the groups listed here are allowed to access this data. The special group 'public' makes data available to all users |
| createdBy | string Functional or user account name who created this instance |
| updatedBy | string Functional or user account name who last updated this instance |
| datasetsId | string |
| datasetId | string |
| rawDatasetId | string |
| derivedDatasetId | string |
| updatedAt | string <date-time> |
{- "sampleId": "string",
- "owner": "string",
- "description": "string",
- "createdAt": "2019-08-24T14:15:22Z",
- "sampleCharacteristics": { },
- "isPublished": true,
- "ownerGroup": "string",
- "accessGroups": [
- "string"
], - "createdBy": "string",
- "updatedBy": "string",
- "datasetsId": "string",
- "datasetId": "string",
- "rawDatasetId": "string",
- "derivedDatasetId": "string",
- "updatedAt": "2019-08-24T14:15:22Z"
}{- "sampleId": "string",
- "owner": "string",
- "description": "string",
- "createdAt": "2019-08-24T14:15:22Z",
- "sampleCharacteristics": { },
- "isPublished": true,
- "ownerGroup": "string",
- "accessGroups": [
- "string"
], - "createdBy": "string",
- "updatedBy": "string",
- "datasetsId": "string",
- "datasetId": "string",
- "rawDatasetId": "string",
- "derivedDatasetId": "string",
- "updatedAt": "2019-08-24T14:15:22Z"
}| id required | string <JSON> Model id |
Model instance data
| sampleId required | string |
| owner | string |
| description | string |
| createdAt | string <date-time> |
| sampleCharacteristics | object |
| isPublished | boolean Flag is true when data are made publically available |
| ownerGroup required | string Defines the group which owns the data, and therefore has unrestricted access to this data. Usually a pgroup like p12151 |
| accessGroups | Array of strings Optional additional groups which have read access to the data. Users which are member in one of the groups listed here are allowed to access this data. The special group 'public' makes data available to all users |
| createdBy | string Functional or user account name who created this instance |
| updatedBy | string Functional or user account name who last updated this instance |
| datasetsId | string |
| datasetId | string |
| rawDatasetId | string |
| derivedDatasetId | string |
| updatedAt | string <date-time> |
{- "sampleId": "string",
- "owner": "string",
- "description": "string",
- "createdAt": "2019-08-24T14:15:22Z",
- "sampleCharacteristics": { },
- "isPublished": true,
- "ownerGroup": "string",
- "accessGroups": [
- "string"
], - "createdBy": "string",
- "updatedBy": "string",
- "datasetsId": "string",
- "datasetId": "string",
- "rawDatasetId": "string",
- "derivedDatasetId": "string",
- "updatedAt": "2019-08-24T14:15:22Z"
}{- "sampleId": "string",
- "owner": "string",
- "description": "string",
- "createdAt": "2019-08-24T14:15:22Z",
- "sampleCharacteristics": { },
- "isPublished": true,
- "ownerGroup": "string",
- "accessGroups": [
- "string"
], - "createdBy": "string",
- "updatedBy": "string",
- "datasetsId": "string",
- "datasetId": "string",
- "rawDatasetId": "string",
- "derivedDatasetId": "string",
- "updatedAt": "2019-08-24T14:15:22Z"
}| filter | string <JSON> Filter defining fields, where, include, order, offset, and limit - must be a JSON-encoded string ( |
{- "sampleId": "string",
- "owner": "string",
- "description": "string",
- "createdAt": "2019-08-24T14:15:22Z",
- "sampleCharacteristics": { },
- "isPublished": true,
- "ownerGroup": "string",
- "accessGroups": [
- "string"
], - "createdBy": "string",
- "updatedBy": "string",
- "datasetsId": "string",
- "datasetId": "string",
- "rawDatasetId": "string",
- "derivedDatasetId": "string",
- "updatedAt": "2019-08-24T14:15:22Z"
}| where | string <JSON> Criteria to match model instances |
An object of model property name/value pairs
| sampleId required | string |
| owner | string |
| description | string |
| createdAt | string <date-time> |
| sampleCharacteristics | object |
| isPublished | boolean Flag is true when data are made publically available |
| ownerGroup required | string Defines the group which owns the data, and therefore has unrestricted access to this data. Usually a pgroup like p12151 |
| accessGroups | Array of strings Optional additional groups which have read access to the data. Users which are member in one of the groups listed here are allowed to access this data. The special group 'public' makes data available to all users |
| createdBy | string Functional or user account name who created this instance |
| updatedBy | string Functional or user account name who last updated this instance |
| datasetsId | string |
| datasetId | string |
| rawDatasetId | string |
| derivedDatasetId | string |
| updatedAt | string <date-time> |
{- "sampleId": "string",
- "owner": "string",
- "description": "string",
- "createdAt": "2019-08-24T14:15:22Z",
- "sampleCharacteristics": { },
- "isPublished": true,
- "ownerGroup": "string",
- "accessGroups": [
- "string"
], - "createdBy": "string",
- "updatedBy": "string",
- "datasetsId": "string",
- "datasetId": "string",
- "rawDatasetId": "string",
- "derivedDatasetId": "string",
- "updatedAt": "2019-08-24T14:15:22Z"
}{- "count": 0
}{ }{ }| fields | string <JSON> Define the filter conditions by specifying the name of values of fields requested. There is also support for a |
| limits | string <JSON> Define further query parameters like skip, limit, order |
{ }Defines the purpose of an experiment and links an experiment to principal investigator and main proposer
| id required | string <JSON> Proposal id |
| fk required | string <JSON> Foreign key for measurementPeriods |
{- "id": "string",
- "instrument": "string",
- "start": "2019-08-24T14:15:22Z",
- "end": "2019-08-24T14:15:22Z",
- "comment": "string"
}| id required | string <JSON> Proposal id |
| fk required | string <JSON> Foreign key for measurementPeriods |
| id required | string id currently needed by limitation in embedsmany |
| instrument required | string Instrument or beamline identifier where measurement was pursued, e.g. /PSI/SLS/TOMCAT |
| start | string <date-time> Time when measurement period started, format according to chapter 5.6 internet date/time format in RFC 3339. Local times without timezone/offset info are automatically transformed to UTC using the timezone of the API server |
| end | string <date-time> Time when measurement period ended, format according to chapter 5.6 internet date/time format in RFC 3339. Local times without timezone/offset info are automatically transformed to UTC using the timezone of the API server |
| comment | string Additional information relevant for this measurement period, e.g. if different accounts were used for data taking |
{- "id": "string",
- "instrument": "string",
- "start": "2019-08-24T14:15:22Z",
- "end": "2019-08-24T14:15:22Z",
- "comment": "string"
}{- "id": "string",
- "instrument": "string",
- "start": "2019-08-24T14:15:22Z",
- "end": "2019-08-24T14:15:22Z",
- "comment": "string"
}| id required | string <JSON> Proposal id |
| fk required | string <JSON> Foreign key for attachments |
{- "thumbnail": "retrieve",
- "caption": "",
- "ownerGroup": "string",
- "accessGroups": [
- "string"
], - "createdBy": "string",
- "updatedBy": "string",
- "id": "string",
- "datasetId": "string",
- "sampleId": "string",
- "proposalId": "string",
- "rawDatasetId": "string",
- "derivedDatasetId": "string",
- "createdAt": "2019-08-24T14:15:22Z",
- "updatedAt": "2019-08-24T14:15:22Z"
}| id required | string <JSON> Proposal id |
| fk required | string <JSON> Foreign key for attachments |
| thumbnail required | string Default: "retrieve" Contains a thumbnail preview in base64 encoded png format for a given dataset |
| caption | string Default: "" Attachment caption to show in catanie |
| ownerGroup required | string Defines the group which owns the data, and therefore has unrestricted access to this data. Usually a pgroup like p12151 |
| accessGroups | Array of strings Optional additional groups which have read access to the data. Users which are member in one of the groups listed here are allowed to access this data. The special group 'public' makes data available to all users |
| createdBy | string Functional or user account name who created this instance |
| updatedBy | string Functional or user account name who last updated this instance |
| id | string (ObjectID) ^[a-fA-F\d]{24}$ |
| datasetId | string |
| sampleId | string |
| proposalId | string |
| rawDatasetId | string |
| derivedDatasetId | string |
| createdAt | string <date-time> |
| updatedAt | string <date-time> |
{- "thumbnail": "retrieve",
- "caption": "",
- "ownerGroup": "string",
- "accessGroups": [
- "string"
], - "createdBy": "string",
- "updatedBy": "string",
- "id": "string",
- "datasetId": "string",
- "sampleId": "string",
- "proposalId": "string",
- "rawDatasetId": "string",
- "derivedDatasetId": "string",
- "createdAt": "2019-08-24T14:15:22Z",
- "updatedAt": "2019-08-24T14:15:22Z"
}{- "thumbnail": "retrieve",
- "caption": "",
- "ownerGroup": "string",
- "accessGroups": [
- "string"
], - "createdBy": "string",
- "updatedBy": "string",
- "id": "string",
- "datasetId": "string",
- "sampleId": "string",
- "proposalId": "string",
- "rawDatasetId": "string",
- "derivedDatasetId": "string",
- "createdAt": "2019-08-24T14:15:22Z",
- "updatedAt": "2019-08-24T14:15:22Z"
}| id required | string <JSON> Proposal id |
| filter | string <JSON> |
[- {
- "id": "string",
- "instrument": "string",
- "start": "2019-08-24T14:15:22Z",
- "end": "2019-08-24T14:15:22Z",
- "comment": "string"
}
]| id required | string <JSON> Proposal id |
| id required | string id currently needed by limitation in embedsmany |
| instrument required | string Instrument or beamline identifier where measurement was pursued, e.g. /PSI/SLS/TOMCAT |
| start | string <date-time> Time when measurement period started, format according to chapter 5.6 internet date/time format in RFC 3339. Local times without timezone/offset info are automatically transformed to UTC using the timezone of the API server |
| end | string <date-time> Time when measurement period ended, format according to chapter 5.6 internet date/time format in RFC 3339. Local times without timezone/offset info are automatically transformed to UTC using the timezone of the API server |
| comment | string Additional information relevant for this measurement period, e.g. if different accounts were used for data taking |
{- "id": "string",
- "instrument": "string",
- "start": "2019-08-24T14:15:22Z",
- "end": "2019-08-24T14:15:22Z",
- "comment": "string"
}{- "id": "string",
- "instrument": "string",
- "start": "2019-08-24T14:15:22Z",
- "end": "2019-08-24T14:15:22Z",
- "comment": "string"
}| id required | string <JSON> Proposal id |
| where | string <JSON> Criteria to match model instances |
{- "count": 0
}| id required | string <JSON> Proposal id |
| filter | string <JSON> |
[- {
- "thumbnail": "retrieve",
- "caption": "",
- "ownerGroup": "string",
- "accessGroups": [
- "string"
], - "createdBy": "string",
- "updatedBy": "string",
- "id": "string",
- "datasetId": "string",
- "sampleId": "string",
- "proposalId": "string",
- "rawDatasetId": "string",
- "derivedDatasetId": "string",
- "createdAt": "2019-08-24T14:15:22Z",
- "updatedAt": "2019-08-24T14:15:22Z"
}
]| id required | string <JSON> Proposal id |
| thumbnail required | string Default: "retrieve" Contains a thumbnail preview in base64 encoded png format for a given dataset |
| caption | string Default: "" Attachment caption to show in catanie |
| ownerGroup required | string Defines the group which owns the data, and therefore has unrestricted access to this data. Usually a pgroup like p12151 |
| accessGroups | Array of strings Optional additional groups which have read access to the data. Users which are member in one of the groups listed here are allowed to access this data. The special group 'public' makes data available to all users |
| createdBy | string Functional or user account name who created this instance |
| updatedBy | string Functional or user account name who last updated this instance |
| id | string (ObjectID) ^[a-fA-F\d]{24}$ |
| datasetId | string |
| sampleId | string |
| proposalId | string |
| rawDatasetId | string |
| derivedDatasetId | string |
| createdAt | string <date-time> |
| updatedAt | string <date-time> |
{- "thumbnail": "retrieve",
- "caption": "",
- "ownerGroup": "string",
- "accessGroups": [
- "string"
], - "createdBy": "string",
- "updatedBy": "string",
- "id": "string",
- "datasetId": "string",
- "sampleId": "string",
- "proposalId": "string",
- "rawDatasetId": "string",
- "derivedDatasetId": "string",
- "createdAt": "2019-08-24T14:15:22Z",
- "updatedAt": "2019-08-24T14:15:22Z"
}{- "thumbnail": "retrieve",
- "caption": "",
- "ownerGroup": "string",
- "accessGroups": [
- "string"
], - "createdBy": "string",
- "updatedBy": "string",
- "id": "string",
- "datasetId": "string",
- "sampleId": "string",
- "proposalId": "string",
- "rawDatasetId": "string",
- "derivedDatasetId": "string",
- "createdAt": "2019-08-24T14:15:22Z",
- "updatedAt": "2019-08-24T14:15:22Z"
}| id required | string <JSON> Proposal id |
| where | string <JSON> Criteria to match model instances |
{- "count": 0
}Model instance data
| proposalId required | string Globally unique identifier of a proposal, eg. PID-prefix/internal-proposal-number. PID prefix is auto prepended |
| pi_email | string Email of principal investigator |
| pi_firstname | string First name of principal investigator |
| pi_lastname | string Last name of principal investigator |
| email required | string Email of main proposer |
| firstname | string First name of main proposer |
| lastname | string Last name of main proposer |
| title | string |
| abstract | string |
| startTime | string <date-time> |
| endTime | string <date-time> |
| ownerGroup required | string Defines the group which owns the data, and therefore has unrestricted access to this data. Usually a pgroup like p12151 |
| accessGroups | Array of strings Optional additional groups which have read access to the data. Users which are member in one of the groups listed here are allowed to access this data. The special group 'public' makes data available to all users |
| createdBy | string Functional or user account name who created this instance |
| updatedBy | string Functional or user account name who last updated this instance |
| createdAt | string <date-time> |
| updatedAt | string <date-time> |
Array of objects (MeasurementPeriod) |
{- "proposalId": "string",
- "pi_email": "string",
- "pi_firstname": "string",
- "pi_lastname": "string",
- "email": "string",
- "firstname": "string",
- "lastname": "string",
- "title": "string",
- "abstract": "string",
- "startTime": "2019-08-24T14:15:22Z",
- "endTime": "2019-08-24T14:15:22Z",
- "ownerGroup": "string",
- "accessGroups": [
- "string"
], - "createdBy": "string",
- "updatedBy": "string",
- "createdAt": "2019-08-24T14:15:22Z",
- "updatedAt": "2019-08-24T14:15:22Z",
- "MeasurementPeriodList": [
- {
- "id": "string",
- "instrument": "string",
- "start": "2019-08-24T14:15:22Z",
- "end": "2019-08-24T14:15:22Z",
- "comment": "string"
}
]
}{- "proposalId": "string",
- "pi_email": "string",
- "pi_firstname": "string",
- "pi_lastname": "string",
- "email": "string",
- "firstname": "string",
- "lastname": "string",
- "title": "string",
- "abstract": "string",
- "startTime": "2019-08-24T14:15:22Z",
- "endTime": "2019-08-24T14:15:22Z",
- "ownerGroup": "string",
- "accessGroups": [
- "string"
], - "createdBy": "string",
- "updatedBy": "string",
- "createdAt": "2019-08-24T14:15:22Z",
- "updatedAt": "2019-08-24T14:15:22Z",
- "MeasurementPeriodList": [
- {
- "id": "string",
- "instrument": "string",
- "start": "2019-08-24T14:15:22Z",
- "end": "2019-08-24T14:15:22Z",
- "comment": "string"
}
]
}Model instance data
| proposalId required | string Globally unique identifier of a proposal, eg. PID-prefix/internal-proposal-number. PID prefix is auto prepended |
| pi_email | string Email of principal investigator |
| pi_firstname | string First name of principal investigator |
| pi_lastname | string Last name of principal investigator |
| email required | string Email of main proposer |
| firstname | string First name of main proposer |
| lastname | string Last name of main proposer |
| title | string |
| abstract | string |
| startTime | string <date-time> |
| endTime | string <date-time> |
| ownerGroup required | string Defines the group which owns the data, and therefore has unrestricted access to this data. Usually a pgroup like p12151 |
| accessGroups | Array of strings Optional additional groups which have read access to the data. Users which are member in one of the groups listed here are allowed to access this data. The special group 'public' makes data available to all users |
| createdBy | string Functional or user account name who created this instance |
| updatedBy | string Functional or user account name who last updated this instance |
| createdAt | string <date-time> |
| updatedAt | string <date-time> |
Array of objects (MeasurementPeriod) |
{- "proposalId": "string",
- "pi_email": "string",
- "pi_firstname": "string",
- "pi_lastname": "string",
- "email": "string",
- "firstname": "string",
- "lastname": "string",
- "title": "string",
- "abstract": "string",
- "startTime": "2019-08-24T14:15:22Z",
- "endTime": "2019-08-24T14:15:22Z",
- "ownerGroup": "string",
- "accessGroups": [
- "string"
], - "createdBy": "string",
- "updatedBy": "string",
- "createdAt": "2019-08-24T14:15:22Z",
- "updatedAt": "2019-08-24T14:15:22Z",
- "MeasurementPeriodList": [
- {
- "id": "string",
- "instrument": "string",
- "start": "2019-08-24T14:15:22Z",
- "end": "2019-08-24T14:15:22Z",
- "comment": "string"
}
]
}{- "proposalId": "string",
- "pi_email": "string",
- "pi_firstname": "string",
- "pi_lastname": "string",
- "email": "string",
- "firstname": "string",
- "lastname": "string",
- "title": "string",
- "abstract": "string",
- "startTime": "2019-08-24T14:15:22Z",
- "endTime": "2019-08-24T14:15:22Z",
- "ownerGroup": "string",
- "accessGroups": [
- "string"
], - "createdBy": "string",
- "updatedBy": "string",
- "createdAt": "2019-08-24T14:15:22Z",
- "updatedAt": "2019-08-24T14:15:22Z",
- "MeasurementPeriodList": [
- {
- "id": "string",
- "instrument": "string",
- "start": "2019-08-24T14:15:22Z",
- "end": "2019-08-24T14:15:22Z",
- "comment": "string"
}
]
}Model instance data
| proposalId required | string Globally unique identifier of a proposal, eg. PID-prefix/internal-proposal-number. PID prefix is auto prepended |
| pi_email | string Email of principal investigator |
| pi_firstname | string First name of principal investigator |
| pi_lastname | string Last name of principal investigator |
| email required | string Email of main proposer |
| firstname | string First name of main proposer |
| lastname | string Last name of main proposer |
| title | string |
| abstract | string |
| startTime | string <date-time> |
| endTime | string <date-time> |
| ownerGroup required | string Defines the group which owns the data, and therefore has unrestricted access to this data. Usually a pgroup like p12151 |
| accessGroups | Array of strings Optional additional groups which have read access to the data. Users which are member in one of the groups listed here are allowed to access this data. The special group 'public' makes data available to all users |
| createdBy | string Functional or user account name who created this instance |
| updatedBy | string Functional or user account name who last updated this instance |
| createdAt | string <date-time> |
| updatedAt | string <date-time> |
Array of objects (MeasurementPeriod) |
{- "proposalId": "string",
- "pi_email": "string",
- "pi_firstname": "string",
- "pi_lastname": "string",
- "email": "string",
- "firstname": "string",
- "lastname": "string",
- "title": "string",
- "abstract": "string",
- "startTime": "2019-08-24T14:15:22Z",
- "endTime": "2019-08-24T14:15:22Z",
- "ownerGroup": "string",
- "accessGroups": [
- "string"
], - "createdBy": "string",
- "updatedBy": "string",
- "createdAt": "2019-08-24T14:15:22Z",
- "updatedAt": "2019-08-24T14:15:22Z",
- "MeasurementPeriodList": [
- {
- "id": "string",
- "instrument": "string",
- "start": "2019-08-24T14:15:22Z",
- "end": "2019-08-24T14:15:22Z",
- "comment": "string"
}
]
}{- "proposalId": "string",
- "pi_email": "string",
- "pi_firstname": "string",
- "pi_lastname": "string",
- "email": "string",
- "firstname": "string",
- "lastname": "string",
- "title": "string",
- "abstract": "string",
- "startTime": "2019-08-24T14:15:22Z",
- "endTime": "2019-08-24T14:15:22Z",
- "ownerGroup": "string",
- "accessGroups": [
- "string"
], - "createdBy": "string",
- "updatedBy": "string",
- "createdAt": "2019-08-24T14:15:22Z",
- "updatedAt": "2019-08-24T14:15:22Z",
- "MeasurementPeriodList": [
- {
- "id": "string",
- "instrument": "string",
- "start": "2019-08-24T14:15:22Z",
- "end": "2019-08-24T14:15:22Z",
- "comment": "string"
}
]
}| filter | string <JSON> Filter defining fields, where, include, order, offset, and limit - must be a JSON-encoded string ( |
[- {
- "proposalId": "string",
- "pi_email": "string",
- "pi_firstname": "string",
- "pi_lastname": "string",
- "email": "string",
- "firstname": "string",
- "lastname": "string",
- "title": "string",
- "abstract": "string",
- "startTime": "2019-08-24T14:15:22Z",
- "endTime": "2019-08-24T14:15:22Z",
- "ownerGroup": "string",
- "accessGroups": [
- "string"
], - "createdBy": "string",
- "updatedBy": "string",
- "createdAt": "2019-08-24T14:15:22Z",
- "updatedAt": "2019-08-24T14:15:22Z",
- "MeasurementPeriodList": [
- {
- "id": "string",
- "instrument": "string",
- "start": "2019-08-24T14:15:22Z",
- "end": "2019-08-24T14:15:22Z",
- "comment": "string"
}
]
}
]Model instance data
| proposalId required | string Globally unique identifier of a proposal, eg. PID-prefix/internal-proposal-number. PID prefix is auto prepended |
| pi_email | string Email of principal investigator |
| pi_firstname | string First name of principal investigator |
| pi_lastname | string Last name of principal investigator |
| email required | string Email of main proposer |
| firstname | string First name of main proposer |
| lastname | string Last name of main proposer |
| title | string |
| abstract | string |
| startTime | string <date-time> |
| endTime | string <date-time> |
| ownerGroup required | string Defines the group which owns the data, and therefore has unrestricted access to this data. Usually a pgroup like p12151 |
| accessGroups | Array of strings Optional additional groups which have read access to the data. Users which are member in one of the groups listed here are allowed to access this data. The special group 'public' makes data available to all users |
| createdBy | string Functional or user account name who created this instance |
| updatedBy | string Functional or user account name who last updated this instance |
| createdAt | string <date-time> |
| updatedAt | string <date-time> |
Array of objects (MeasurementPeriod) |
{- "proposalId": "string",
- "pi_email": "string",
- "pi_firstname": "string",
- "pi_lastname": "string",
- "email": "string",
- "firstname": "string",
- "lastname": "string",
- "title": "string",
- "abstract": "string",
- "startTime": "2019-08-24T14:15:22Z",
- "endTime": "2019-08-24T14:15:22Z",
- "ownerGroup": "string",
- "accessGroups": [
- "string"
], - "createdBy": "string",
- "updatedBy": "string",
- "createdAt": "2019-08-24T14:15:22Z",
- "updatedAt": "2019-08-24T14:15:22Z",
- "MeasurementPeriodList": [
- {
- "id": "string",
- "instrument": "string",
- "start": "2019-08-24T14:15:22Z",
- "end": "2019-08-24T14:15:22Z",
- "comment": "string"
}
]
}{- "proposalId": "string",
- "pi_email": "string",
- "pi_firstname": "string",
- "pi_lastname": "string",
- "email": "string",
- "firstname": "string",
- "lastname": "string",
- "title": "string",
- "abstract": "string",
- "startTime": "2019-08-24T14:15:22Z",
- "endTime": "2019-08-24T14:15:22Z",
- "ownerGroup": "string",
- "accessGroups": [
- "string"
], - "createdBy": "string",
- "updatedBy": "string",
- "createdAt": "2019-08-24T14:15:22Z",
- "updatedAt": "2019-08-24T14:15:22Z",
- "MeasurementPeriodList": [
- {
- "id": "string",
- "instrument": "string",
- "start": "2019-08-24T14:15:22Z",
- "end": "2019-08-24T14:15:22Z",
- "comment": "string"
}
]
}| where | string <JSON> Criteria to match model instances |
An object of model property name/value pairs
| proposalId required | string Globally unique identifier of a proposal, eg. PID-prefix/internal-proposal-number. PID prefix is auto prepended |
| pi_email | string Email of principal investigator |
| pi_firstname | string First name of principal investigator |
| pi_lastname | string Last name of principal investigator |
| email required | string Email of main proposer |
| firstname | string First name of main proposer |
| lastname | string Last name of main proposer |
| title | string |
| abstract | string |
| startTime | string <date-time> |
| endTime | string <date-time> |
| ownerGroup required | string Defines the group which owns the data, and therefore has unrestricted access to this data. Usually a pgroup like p12151 |
| accessGroups | Array of strings Optional additional groups which have read access to the data. Users which are member in one of the groups listed here are allowed to access this data. The special group 'public' makes data available to all users |
| createdBy | string Functional or user account name who created this instance |
| updatedBy | string Functional or user account name who last updated this instance |
| createdAt | string <date-time> |
| updatedAt | string <date-time> |
Array of objects (MeasurementPeriod) |
{- "proposalId": "string",
- "pi_email": "string",
- "pi_firstname": "string",
- "pi_lastname": "string",
- "email": "string",
- "firstname": "string",
- "lastname": "string",
- "title": "string",
- "abstract": "string",
- "startTime": "2019-08-24T14:15:22Z",
- "endTime": "2019-08-24T14:15:22Z",
- "ownerGroup": "string",
- "accessGroups": [
- "string"
], - "createdBy": "string",
- "updatedBy": "string",
- "createdAt": "2019-08-24T14:15:22Z",
- "updatedAt": "2019-08-24T14:15:22Z",
- "MeasurementPeriodList": [
- {
- "id": "string",
- "instrument": "string",
- "start": "2019-08-24T14:15:22Z",
- "end": "2019-08-24T14:15:22Z",
- "comment": "string"
}
]
}{- "proposalId": "string",
- "pi_email": "string",
- "pi_firstname": "string",
- "pi_lastname": "string",
- "email": "string",
- "firstname": "string",
- "lastname": "string",
- "title": "string",
- "abstract": "string",
- "startTime": "2019-08-24T14:15:22Z",
- "endTime": "2019-08-24T14:15:22Z",
- "ownerGroup": "string",
- "accessGroups": [
- "string"
], - "createdBy": "string",
- "updatedBy": "string",
- "createdAt": "2019-08-24T14:15:22Z",
- "updatedAt": "2019-08-24T14:15:22Z",
- "MeasurementPeriodList": [
- {
- "id": "string",
- "instrument": "string",
- "start": "2019-08-24T14:15:22Z",
- "end": "2019-08-24T14:15:22Z",
- "comment": "string"
}
]
}| id required | string <JSON> Model id |
| filter | string <JSON> Filter defining fields and include - must be a JSON-encoded string ({"something":"value"}) |
{- "proposalId": "string",
- "pi_email": "string",
- "pi_firstname": "string",
- "pi_lastname": "string",
- "email": "string",
- "firstname": "string",
- "lastname": "string",
- "title": "string",
- "abstract": "string",
- "startTime": "2019-08-24T14:15:22Z",
- "endTime": "2019-08-24T14:15:22Z",
- "ownerGroup": "string",
- "accessGroups": [
- "string"
], - "createdBy": "string",
- "updatedBy": "string",
- "createdAt": "2019-08-24T14:15:22Z",
- "updatedAt": "2019-08-24T14:15:22Z",
- "MeasurementPeriodList": [
- {
- "id": "string",
- "instrument": "string",
- "start": "2019-08-24T14:15:22Z",
- "end": "2019-08-24T14:15:22Z",
- "comment": "string"
}
]
}| id required | string <JSON> Model id |
Model instance data
| proposalId required | string Globally unique identifier of a proposal, eg. PID-prefix/internal-proposal-number. PID prefix is auto prepended |
| pi_email | string Email of principal investigator |
| pi_firstname | string First name of principal investigator |
| pi_lastname | string Last name of principal investigator |
| email required | string Email of main proposer |
| firstname | string First name of main proposer |
| lastname | string Last name of main proposer |
| title | string |
| abstract | string |
| startTime | string <date-time> |
| endTime | string <date-time> |
| ownerGroup required | string Defines the group which owns the data, and therefore has unrestricted access to this data. Usually a pgroup like p12151 |
| accessGroups | Array of strings Optional additional groups which have read access to the data. Users which are member in one of the groups listed here are allowed to access this data. The special group 'public' makes data available to all users |
| createdBy | string Functional or user account name who created this instance |
| updatedBy | string Functional or user account name who last updated this instance |
| createdAt | string <date-time> |
| updatedAt | string <date-time> |
Array of objects (MeasurementPeriod) |
{- "proposalId": "string",
- "pi_email": "string",
- "pi_firstname": "string",
- "pi_lastname": "string",
- "email": "string",
- "firstname": "string",
- "lastname": "string",
- "title": "string",
- "abstract": "string",
- "startTime": "2019-08-24T14:15:22Z",
- "endTime": "2019-08-24T14:15:22Z",
- "ownerGroup": "string",
- "accessGroups": [
- "string"
], - "createdBy": "string",
- "updatedBy": "string",
- "createdAt": "2019-08-24T14:15:22Z",
- "updatedAt": "2019-08-24T14:15:22Z",
- "MeasurementPeriodList": [
- {
- "id": "string",
- "instrument": "string",
- "start": "2019-08-24T14:15:22Z",
- "end": "2019-08-24T14:15:22Z",
- "comment": "string"
}
]
}{- "proposalId": "string",
- "pi_email": "string",
- "pi_firstname": "string",
- "pi_lastname": "string",
- "email": "string",
- "firstname": "string",
- "lastname": "string",
- "title": "string",
- "abstract": "string",
- "startTime": "2019-08-24T14:15:22Z",
- "endTime": "2019-08-24T14:15:22Z",
- "ownerGroup": "string",
- "accessGroups": [
- "string"
], - "createdBy": "string",
- "updatedBy": "string",
- "createdAt": "2019-08-24T14:15:22Z",
- "updatedAt": "2019-08-24T14:15:22Z",
- "MeasurementPeriodList": [
- {
- "id": "string",
- "instrument": "string",
- "start": "2019-08-24T14:15:22Z",
- "end": "2019-08-24T14:15:22Z",
- "comment": "string"
}
]
}| id required | string <JSON> Proposal id |
An object of model property name/value pairs
| proposalId required | string Globally unique identifier of a proposal, eg. PID-prefix/internal-proposal-number. PID prefix is auto prepended |
| pi_email | string Email of principal investigator |
| pi_firstname | string First name of principal investigator |
| pi_lastname | string Last name of principal investigator |
| email required | string Email of main proposer |
| firstname | string First name of main proposer |
| lastname | string Last name of main proposer |
| title | string |
| abstract | string |
| startTime | string <date-time> |
| endTime | string <date-time> |
| ownerGroup required | string Defines the group which owns the data, and therefore has unrestricted access to this data. Usually a pgroup like p12151 |
| accessGroups | Array of strings Optional additional groups which have read access to the data. Users which are member in one of the groups listed here are allowed to access this data. The special group 'public' makes data available to all users |
| createdBy | string Functional or user account name who created this instance |
| updatedBy | string Functional or user account name who last updated this instance |
| createdAt | string <date-time> |
| updatedAt | string <date-time> |
Array of objects (MeasurementPeriod) |
{- "proposalId": "string",
- "pi_email": "string",
- "pi_firstname": "string",
- "pi_lastname": "string",
- "email": "string",
- "firstname": "string",
- "lastname": "string",
- "title": "string",
- "abstract": "string",
- "startTime": "2019-08-24T14:15:22Z",
- "endTime": "2019-08-24T14:15:22Z",
- "ownerGroup": "string",
- "accessGroups": [
- "string"
], - "createdBy": "string",
- "updatedBy": "string",
- "createdAt": "2019-08-24T14:15:22Z",
- "updatedAt": "2019-08-24T14:15:22Z",
- "MeasurementPeriodList": [
- {
- "id": "string",
- "instrument": "string",
- "start": "2019-08-24T14:15:22Z",
- "end": "2019-08-24T14:15:22Z",
- "comment": "string"
}
]
}{- "proposalId": "string",
- "pi_email": "string",
- "pi_firstname": "string",
- "pi_lastname": "string",
- "email": "string",
- "firstname": "string",
- "lastname": "string",
- "title": "string",
- "abstract": "string",
- "startTime": "2019-08-24T14:15:22Z",
- "endTime": "2019-08-24T14:15:22Z",
- "ownerGroup": "string",
- "accessGroups": [
- "string"
], - "createdBy": "string",
- "updatedBy": "string",
- "createdAt": "2019-08-24T14:15:22Z",
- "updatedAt": "2019-08-24T14:15:22Z",
- "MeasurementPeriodList": [
- {
- "id": "string",
- "instrument": "string",
- "start": "2019-08-24T14:15:22Z",
- "end": "2019-08-24T14:15:22Z",
- "comment": "string"
}
]
}| id required | string <JSON> Model id |
Model instance data
| proposalId required | string Globally unique identifier of a proposal, eg. PID-prefix/internal-proposal-number. PID prefix is auto prepended |
| pi_email | string Email of principal investigator |
| pi_firstname | string First name of principal investigator |
| pi_lastname | string Last name of principal investigator |
| email required | string Email of main proposer |
| firstname | string First name of main proposer |
| lastname | string Last name of main proposer |
| title | string |
| abstract | string |
| startTime | string <date-time> |
| endTime | string <date-time> |
| ownerGroup required | string Defines the group which owns the data, and therefore has unrestricted access to this data. Usually a pgroup like p12151 |
| accessGroups | Array of strings Optional additional groups which have read access to the data. Users which are member in one of the groups listed here are allowed to access this data. The special group 'public' makes data available to all users |
| createdBy | string Functional or user account name who created this instance |
| updatedBy | string Functional or user account name who last updated this instance |
| createdAt | string <date-time> |
| updatedAt | string <date-time> |
Array of objects (MeasurementPeriod) |
{- "proposalId": "string",
- "pi_email": "string",
- "pi_firstname": "string",
- "pi_lastname": "string",
- "email": "string",
- "firstname": "string",
- "lastname": "string",
- "title": "string",
- "abstract": "string",
- "startTime": "2019-08-24T14:15:22Z",
- "endTime": "2019-08-24T14:15:22Z",
- "ownerGroup": "string",
- "accessGroups": [
- "string"
], - "createdBy": "string",
- "updatedBy": "string",
- "createdAt": "2019-08-24T14:15:22Z",
- "updatedAt": "2019-08-24T14:15:22Z",
- "MeasurementPeriodList": [
- {
- "id": "string",
- "instrument": "string",
- "start": "2019-08-24T14:15:22Z",
- "end": "2019-08-24T14:15:22Z",
- "comment": "string"
}
]
}{- "proposalId": "string",
- "pi_email": "string",
- "pi_firstname": "string",
- "pi_lastname": "string",
- "email": "string",
- "firstname": "string",
- "lastname": "string",
- "title": "string",
- "abstract": "string",
- "startTime": "2019-08-24T14:15:22Z",
- "endTime": "2019-08-24T14:15:22Z",
- "ownerGroup": "string",
- "accessGroups": [
- "string"
], - "createdBy": "string",
- "updatedBy": "string",
- "createdAt": "2019-08-24T14:15:22Z",
- "updatedAt": "2019-08-24T14:15:22Z",
- "MeasurementPeriodList": [
- {
- "id": "string",
- "instrument": "string",
- "start": "2019-08-24T14:15:22Z",
- "end": "2019-08-24T14:15:22Z",
- "comment": "string"
}
]
}| filter | string <JSON> Filter defining fields, where, include, order, offset, and limit - must be a JSON-encoded string ( |
{- "proposalId": "string",
- "pi_email": "string",
- "pi_firstname": "string",
- "pi_lastname": "string",
- "email": "string",
- "firstname": "string",
- "lastname": "string",
- "title": "string",
- "abstract": "string",
- "startTime": "2019-08-24T14:15:22Z",
- "endTime": "2019-08-24T14:15:22Z",
- "ownerGroup": "string",
- "accessGroups": [
- "string"
], - "createdBy": "string",
- "updatedBy": "string",
- "createdAt": "2019-08-24T14:15:22Z",
- "updatedAt": "2019-08-24T14:15:22Z",
- "MeasurementPeriodList": [
- {
- "id": "string",
- "instrument": "string",
- "start": "2019-08-24T14:15:22Z",
- "end": "2019-08-24T14:15:22Z",
- "comment": "string"
}
]
}| where | string <JSON> Criteria to match model instances |
An object of model property name/value pairs
| proposalId required | string Globally unique identifier of a proposal, eg. PID-prefix/internal-proposal-number. PID prefix is auto prepended |
| pi_email | string Email of principal investigator |
| pi_firstname | string First name of principal investigator |
| pi_lastname | string Last name of principal investigator |
| email required | string Email of main proposer |
| firstname | string First name of main proposer |
| lastname | string Last name of main proposer |
| title | string |
| abstract | string |
| startTime | string <date-time> |
| endTime | string <date-time> |
| ownerGroup required | string Defines the group which owns the data, and therefore has unrestricted access to this data. Usually a pgroup like p12151 |
| accessGroups | Array of strings Optional additional groups which have read access to the data. Users which are member in one of the groups listed here are allowed to access this data. The special group 'public' makes data available to all users |
| createdBy | string Functional or user account name who created this instance |
| updatedBy | string Functional or user account name who last updated this instance |
| createdAt | string <date-time> |
| updatedAt | string <date-time> |
Array of objects (MeasurementPeriod) |
{- "proposalId": "string",
- "pi_email": "string",
- "pi_firstname": "string",
- "pi_lastname": "string",
- "email": "string",
- "firstname": "string",
- "lastname": "string",
- "title": "string",
- "abstract": "string",
- "startTime": "2019-08-24T14:15:22Z",
- "endTime": "2019-08-24T14:15:22Z",
- "ownerGroup": "string",
- "accessGroups": [
- "string"
], - "createdBy": "string",
- "updatedBy": "string",
- "createdAt": "2019-08-24T14:15:22Z",
- "updatedAt": "2019-08-24T14:15:22Z",
- "MeasurementPeriodList": [
- {
- "id": "string",
- "instrument": "string",
- "start": "2019-08-24T14:15:22Z",
- "end": "2019-08-24T14:15:22Z",
- "comment": "string"
}
]
}{- "count": 0
}{ }{ }| fields | string <JSON> Define the filter conditions by specifying the name of values of fields requested. There is also support for a |
| limits | string <JSON> Define further query parameters like skip, limit, order |
{ }Stores the meta data information for an accessible, published and DOI-identified collection of datasets. It defines a list of mandatory and optional metadata fields to be included. DataCite mandatory fields, a full URL to the landing page and modification times are included.
| id required | string <JSON> PublishedData id |
| fk required | string <JSON> Foreign key for datasets |
{- "pid": "string",
- "owner": "string",
- "ownerEmail": "string",
- "orcidOfOwner": "string",
- "contactEmail": "string",
- "sourceFolder": "string",
- "sourceFolderHost": "string",
- "size": 0,
- "packedSize": 0,
- "numberOfFiles": 0,
- "numberOfFilesArchived": 0,
- "creationTime": "2019-08-24T14:15:22Z",
- "type": "string",
- "validationStatus": "string",
- "keywords": [
- "string"
], - "description": "string",
- "datasetName": "string",
- "classification": "string",
- "license": "string",
- "version": "string",
- "isPublished": true,
- "ownerGroup": "string",
- "accessGroups": [
- "string"
], - "createdBy": "string",
- "updatedBy": "string",
- "createdAt": "2019-08-24T14:15:22Z",
- "updatedAt": "2019-08-24T14:15:22Z",
- "publishedDataId": "string",
- "publisheddataId": "string",
- "datasetlifecycle": {
- "archivable": true,
- "retrievable": true,
- "publishable": true,
- "dateOfDiskPurging": "2019-08-24T14:15:22Z",
- "archiveRetentionTime": "2019-08-24T14:15:22Z",
- "dateOfPublishing": "2019-08-24T14:15:22Z",
- "isOnCentralDisk": true,
- "archiveStatusMessage": "string",
- "retrieveStatusMessage": "string",
- "archiveReturnMessage": { },
- "retrieveReturnMessage": { },
- "exportedTo": "string",
- "retrieveIntegrityCheck": true,
- "id": "string"
}, - "history": [
- {
- "id": "string"
}
], - "instrumentId": "string",
- "techniques": [
- {
- "pid": "string",
- "name": "string"
}
]
}| id required | string <JSON> PublishedData id |
| fk required | string <JSON> Foreign key for datasets |
| pid required | string Persistent Identifier for datasets derived from UUIDv4 and prepended automatically by site specific PID prefix like 20.500.12345/ |
| owner required | string Owner of the data set, usually first name + lastname |
| ownerEmail | string Email of owner of the data set |
| orcidOfOwner | string ORCID of owner https://orcid.org if available |
| contactEmail required | string Email of contact person for this dataset |
| sourceFolder required | string Absolute file path on file server containing the files of this dataset, e.g. /some/path/to/sourcefolder. In case of a single file dataset, e.g. HDF5 data, it contains the path up to, but excluding the filename. Trailing slashes are removed. |
| sourceFolderHost | string DNS host name of file server hosting sourceFolder, optionally including protocol e.g. [protocol://]fileserver1.example.com |
| size | number <double> Total size of all source files contained in source folder on disk when unpacked |
| packedSize | number <double> Total size of all datablock package files created for this dataset |
| numberOfFiles | number <double> Total number of lines in filelisting of all OrigDatablocks for this dataset |
| numberOfFilesArchived | number <double> Total number of lines in filelisting of all Datablocks for this dataset |
| creationTime required | string <date-time> Time when dataset became fully available on disk, i.e. all containing files have been written. Format according to chapter 5.6 internet date/time format in RFC 3339. Local times without timezone/offset info are automatically transformed to UTC using the timezone of the API server. |
| type required | string Characterize type of dataset, either 'base' or 'raw' or 'derived'. Autofilled when choosing the proper inherited models |
| validationStatus | string Defines a level of trust, e.g. a measure of how much data was verified or used by other persons |
| keywords | Array of strings Array of tags associated with the meaning or contents of this dataset. Values should ideally come from defined vocabularies, taxonomies, ontologies or knowledge graphs |
| description | string Free text explanation of contents of dataset |
| datasetName | string A name for the dataset, given by the creator to carry some semantic meaning. Useful for display purposes e.g. instead of displaying the pid. Will be autofilled if missing using info from sourceFolder |
| classification | string ACIA information about AUthenticity,COnfidentiality,INtegrity and AVailability requirements of dataset. E.g. AV(ailabilty)=medium could trigger the creation of a two tape copies. Format 'AV=medium,CO=low' |
| license | string Name of license under which data can be used |
| version | string Version of API used in creation of dataset |
| isPublished | boolean Flag is true when data are made publically available |
| ownerGroup required | string Defines the group which owns the data, and therefore has unrestricted access to this data. Usually a pgroup like p12151 |
| accessGroups | Array of strings Optional additional groups which have read access to the data. Users which are member in one of the groups listed here are allowed to access this data. The special group 'public' makes data available to all users |
| createdBy | string Functional or user account name who created this instance |
| updatedBy | string Functional or user account name who last updated this instance |
| createdAt | string <date-time> |
| updatedAt | string <date-time> |
| publishedDataId | string |
| publisheddataId | string |
object (DatasetLifecycle) For each dataset there exists an embedded dataset lifecycle document which describes the current status of the dataset during its lifetime with respect to the storage handling systems | |
Array of objects (Message) | |
| instrumentId | string |
Array of objects (Technique) |
{- "pid": "string",
- "owner": "string",
- "ownerEmail": "string",
- "orcidOfOwner": "string",
- "contactEmail": "string",
- "sourceFolder": "string",
- "sourceFolderHost": "string",
- "size": 0,
- "packedSize": 0,
- "numberOfFiles": 0,
- "numberOfFilesArchived": 0,
- "creationTime": "2019-08-24T14:15:22Z",
- "type": "string",
- "validationStatus": "string",
- "keywords": [
- "string"
], - "description": "string",
- "datasetName": "string",
- "classification": "string",
- "license": "string",
- "version": "string",
- "isPublished": true,
- "ownerGroup": "string",
- "accessGroups": [
- "string"
], - "createdBy": "string",
- "updatedBy": "string",
- "createdAt": "2019-08-24T14:15:22Z",
- "updatedAt": "2019-08-24T14:15:22Z",
- "publishedDataId": "string",
- "publisheddataId": "string",
- "datasetlifecycle": {
- "archivable": true,
- "retrievable": true,
- "publishable": true,
- "dateOfDiskPurging": "2019-08-24T14:15:22Z",
- "archiveRetentionTime": "2019-08-24T14:15:22Z",
- "dateOfPublishing": "2019-08-24T14:15:22Z",
- "isOnCentralDisk": true,
- "archiveStatusMessage": "string",
- "retrieveStatusMessage": "string",
- "archiveReturnMessage": { },
- "retrieveReturnMessage": { },
- "exportedTo": "string",
- "retrieveIntegrityCheck": true,
- "id": "string"
}, - "history": [
- {
- "id": "string"
}
], - "instrumentId": "string",
- "techniques": [
- {
- "pid": "string",
- "name": "string"
}
]
}{- "pid": "string",
- "owner": "string",
- "ownerEmail": "string",
- "orcidOfOwner": "string",
- "contactEmail": "string",
- "sourceFolder": "string",
- "sourceFolderHost": "string",
- "size": 0,
- "packedSize": 0,
- "numberOfFiles": 0,
- "numberOfFilesArchived": 0,
- "creationTime": "2019-08-24T14:15:22Z",
- "type": "string",
- "validationStatus": "string",
- "keywords": [
- "string"
], - "description": "string",
- "datasetName": "string",
- "classification": "string",
- "license": "string",
- "version": "string",
- "isPublished": true,
- "ownerGroup": "string",
- "accessGroups": [
- "string"
], - "createdBy": "string",
- "updatedBy": "string",
- "createdAt": "2019-08-24T14:15:22Z",
- "updatedAt": "2019-08-24T14:15:22Z",
- "publishedDataId": "string",
- "publisheddataId": "string",
- "datasetlifecycle": {
- "archivable": true,
- "retrievable": true,
- "publishable": true,
- "dateOfDiskPurging": "2019-08-24T14:15:22Z",
- "archiveRetentionTime": "2019-08-24T14:15:22Z",
- "dateOfPublishing": "2019-08-24T14:15:22Z",
- "isOnCentralDisk": true,
- "archiveStatusMessage": "string",
- "retrieveStatusMessage": "string",
- "archiveReturnMessage": { },
- "retrieveReturnMessage": { },
- "exportedTo": "string",
- "retrieveIntegrityCheck": true,
- "id": "string"
}, - "history": [
- {
- "id": "string"
}
], - "instrumentId": "string",
- "techniques": [
- {
- "pid": "string",
- "name": "string"
}
]
}| id required | string <JSON> PublishedData id |
| filter | string <JSON> |
[- {
- "pid": "string",
- "owner": "string",
- "ownerEmail": "string",
- "orcidOfOwner": "string",
- "contactEmail": "string",
- "sourceFolder": "string",
- "sourceFolderHost": "string",
- "size": 0,
- "packedSize": 0,
- "numberOfFiles": 0,
- "numberOfFilesArchived": 0,
- "creationTime": "2019-08-24T14:15:22Z",
- "type": "string",
- "validationStatus": "string",
- "keywords": [
- "string"
], - "description": "string",
- "datasetName": "string",
- "classification": "string",
- "license": "string",
- "version": "string",
- "isPublished": true,
- "ownerGroup": "string",
- "accessGroups": [
- "string"
], - "createdBy": "string",
- "updatedBy": "string",
- "createdAt": "2019-08-24T14:15:22Z",
- "updatedAt": "2019-08-24T14:15:22Z",
- "publishedDataId": "string",
- "publisheddataId": "string",
- "datasetlifecycle": {
- "archivable": true,
- "retrievable": true,
- "publishable": true,
- "dateOfDiskPurging": "2019-08-24T14:15:22Z",
- "archiveRetentionTime": "2019-08-24T14:15:22Z",
- "dateOfPublishing": "2019-08-24T14:15:22Z",
- "isOnCentralDisk": true,
- "archiveStatusMessage": "string",
- "retrieveStatusMessage": "string",
- "archiveReturnMessage": { },
- "retrieveReturnMessage": { },
- "exportedTo": "string",
- "retrieveIntegrityCheck": true,
- "id": "string"
}, - "history": [
- {
- "id": "string"
}
], - "instrumentId": "string",
- "techniques": [
- {
- "pid": "string",
- "name": "string"
}
]
}
]| id required | string <JSON> PublishedData id |
| pid required | string Persistent Identifier for datasets derived from UUIDv4 and prepended automatically by site specific PID prefix like 20.500.12345/ |
| owner required | string Owner of the data set, usually first name + lastname |
| ownerEmail | string Email of owner of the data set |
| orcidOfOwner | string ORCID of owner https://orcid.org if available |
| contactEmail required | string Email of contact person for this dataset |
| sourceFolder required | string Absolute file path on file server containing the files of this dataset, e.g. /some/path/to/sourcefolder. In case of a single file dataset, e.g. HDF5 data, it contains the path up to, but excluding the filename. Trailing slashes are removed. |
| sourceFolderHost | string DNS host name of file server hosting sourceFolder, optionally including protocol e.g. [protocol://]fileserver1.example.com |
| size | number <double> Total size of all source files contained in source folder on disk when unpacked |
| packedSize | number <double> Total size of all datablock package files created for this dataset |
| numberOfFiles | number <double> Total number of lines in filelisting of all OrigDatablocks for this dataset |
| numberOfFilesArchived | number <double> Total number of lines in filelisting of all Datablocks for this dataset |
| creationTime required | string <date-time> Time when dataset became fully available on disk, i.e. all containing files have been written. Format according to chapter 5.6 internet date/time format in RFC 3339. Local times without timezone/offset info are automatically transformed to UTC using the timezone of the API server. |
| type required | string Characterize type of dataset, either 'base' or 'raw' or 'derived'. Autofilled when choosing the proper inherited models |
| validationStatus | string Defines a level of trust, e.g. a measure of how much data was verified or used by other persons |
| keywords | Array of strings Array of tags associated with the meaning or contents of this dataset. Values should ideally come from defined vocabularies, taxonomies, ontologies or knowledge graphs |
| description | string Free text explanation of contents of dataset |
| datasetName | string A name for the dataset, given by the creator to carry some semantic meaning. Useful for display purposes e.g. instead of displaying the pid. Will be autofilled if missing using info from sourceFolder |
| classification | string ACIA information about AUthenticity,COnfidentiality,INtegrity and AVailability requirements of dataset. E.g. AV(ailabilty)=medium could trigger the creation of a two tape copies. Format 'AV=medium,CO=low' |
| license | string Name of license under which data can be used |
| version | string Version of API used in creation of dataset |
| isPublished | boolean Flag is true when data are made publically available |
| ownerGroup required | string Defines the group which owns the data, and therefore has unrestricted access to this data. Usually a pgroup like p12151 |
| accessGroups | Array of strings Optional additional groups which have read access to the data. Users which are member in one of the groups listed here are allowed to access this data. The special group 'public' makes data available to all users |
| createdBy | string Functional or user account name who created this instance |
| updatedBy | string Functional or user account name who last updated this instance |
| createdAt | string <date-time> |
| updatedAt | string <date-time> |
| publishedDataId | string |
| publisheddataId | string |
object (DatasetLifecycle) For each dataset there exists an embedded dataset lifecycle document which describes the current status of the dataset during its lifetime with respect to the storage handling systems | |
Array of objects (Message) | |
| instrumentId | string |
Array of objects (Technique) |
{- "pid": "string",
- "owner": "string",
- "ownerEmail": "string",
- "orcidOfOwner": "string",
- "contactEmail": "string",
- "sourceFolder": "string",
- "sourceFolderHost": "string",
- "size": 0,
- "packedSize": 0,
- "numberOfFiles": 0,
- "numberOfFilesArchived": 0,
- "creationTime": "2019-08-24T14:15:22Z",
- "type": "string",
- "validationStatus": "string",
- "keywords": [
- "string"
], - "description": "string",
- "datasetName": "string",
- "classification": "string",
- "license": "string",
- "version": "string",
- "isPublished": true,
- "ownerGroup": "string",
- "accessGroups": [
- "string"
], - "createdBy": "string",
- "updatedBy": "string",
- "createdAt": "2019-08-24T14:15:22Z",
- "updatedAt": "2019-08-24T14:15:22Z",
- "publishedDataId": "string",
- "publisheddataId": "string",
- "datasetlifecycle": {
- "archivable": true,
- "retrievable": true,
- "publishable": true,
- "dateOfDiskPurging": "2019-08-24T14:15:22Z",
- "archiveRetentionTime": "2019-08-24T14:15:22Z",
- "dateOfPublishing": "2019-08-24T14:15:22Z",
- "isOnCentralDisk": true,
- "archiveStatusMessage": "string",
- "retrieveStatusMessage": "string",
- "archiveReturnMessage": { },
- "retrieveReturnMessage": { },
- "exportedTo": "string",
- "retrieveIntegrityCheck": true,
- "id": "string"
}, - "history": [
- {
- "id": "string"
}
], - "instrumentId": "string",
- "techniques": [
- {
- "pid": "string",
- "name": "string"
}
]
}{- "pid": "string",
- "owner": "string",
- "ownerEmail": "string",
- "orcidOfOwner": "string",
- "contactEmail": "string",
- "sourceFolder": "string",
- "sourceFolderHost": "string",
- "size": 0,
- "packedSize": 0,
- "numberOfFiles": 0,
- "numberOfFilesArchived": 0,
- "creationTime": "2019-08-24T14:15:22Z",
- "type": "string",
- "validationStatus": "string",
- "keywords": [
- "string"
], - "description": "string",
- "datasetName": "string",
- "classification": "string",
- "license": "string",
- "version": "string",
- "isPublished": true,
- "ownerGroup": "string",
- "accessGroups": [
- "string"
], - "createdBy": "string",
- "updatedBy": "string",
- "createdAt": "2019-08-24T14:15:22Z",
- "updatedAt": "2019-08-24T14:15:22Z",
- "publishedDataId": "string",
- "publisheddataId": "string",
- "datasetlifecycle": {
- "archivable": true,
- "retrievable": true,
- "publishable": true,
- "dateOfDiskPurging": "2019-08-24T14:15:22Z",
- "archiveRetentionTime": "2019-08-24T14:15:22Z",
- "dateOfPublishing": "2019-08-24T14:15:22Z",
- "isOnCentralDisk": true,
- "archiveStatusMessage": "string",
- "retrieveStatusMessage": "string",
- "archiveReturnMessage": { },
- "retrieveReturnMessage": { },
- "exportedTo": "string",
- "retrieveIntegrityCheck": true,
- "id": "string"
}, - "history": [
- {
- "id": "string"
}
], - "instrumentId": "string",
- "techniques": [
- {
- "pid": "string",
- "name": "string"
}
]
}| id required | string <JSON> PublishedData id |
| where | string <JSON> Criteria to match model instances |
{- "count": 0
}Model instance data
| doi required | string Digital Object Identifier |
| affiliation | string Creator Affiliation |
| creator required | Array of strings Creator of dataset/dataset collection |
| publisher required | string Dataset publisher |
| publicationYear required | number <double> Year of publication |
| title required | string Title |
| url | string Full URL to the landing page for this DOI |
| abstract required | string Abstract text for published datasets |
| dataDescription required | string Link to description of how to re-use data |
| resourceType required | string e.g. raw/ derived |
| numberOfFiles | number <double> Number of files |
| sizeOfArchive | number <double> Size of archive |
| pidArray required | Array of strings Array of one or more PIDS which make up the published data |
| authors | Array of strings List of Names of authors of the to be published data |
| registeredTime | string <date-time> Time when doi is successfully registered |
| status | string Indication of position in publication workflow e.g. doiRegistered |
| scicatUser | string The username of the user that clicks the publish button in the client |
| thumbnail | string Small, less than 16 MB base 64 image preview of dataset |
| relatedPublications | Array of strings List of URLs pointing to related publications like DOI URLS of journal articles |
| downloadLink | string URL pointing to page from which data can be downloaded |
| createdBy | string Functional or user account name who created this instance |
| updatedBy | string Functional or user account name who last updated this instance |
| createdAt | string <date-time> |
| updatedAt | string <date-time> |
{- "doi": "string",
- "affiliation": "string",
- "creator": [
- "string"
], - "publisher": "string",
- "publicationYear": 0,
- "title": "string",
- "url": "string",
- "abstract": "string",
- "dataDescription": "string",
- "resourceType": "string",
- "numberOfFiles": 0,
- "sizeOfArchive": 0,
- "pidArray": [
- "string"
], - "authors": [
- "string"
], - "registeredTime": "2019-08-24T14:15:22Z",
- "status": "string",
- "scicatUser": "string",
- "thumbnail": "string",
- "relatedPublications": [
- "string"
], - "downloadLink": "string",
- "createdBy": "string",
- "updatedBy": "string",
- "createdAt": "2019-08-24T14:15:22Z",
- "updatedAt": "2019-08-24T14:15:22Z"
}{- "doi": "string",
- "affiliation": "string",
- "creator": [
- "string"
], - "publisher": "string",
- "publicationYear": 0,
- "title": "string",
- "url": "string",
- "abstract": "string",
- "dataDescription": "string",
- "resourceType": "string",
- "numberOfFiles": 0,
- "sizeOfArchive": 0,
- "pidArray": [
- "string"
], - "authors": [
- "string"
], - "registeredTime": "2019-08-24T14:15:22Z",
- "status": "string",
- "scicatUser": "string",
- "thumbnail": "string",
- "relatedPublications": [
- "string"
], - "downloadLink": "string",
- "createdBy": "string",
- "updatedBy": "string",
- "createdAt": "2019-08-24T14:15:22Z",
- "updatedAt": "2019-08-24T14:15:22Z"
}Model instance data
| doi required | string Digital Object Identifier |
| affiliation | string Creator Affiliation |
| creator required | Array of strings Creator of dataset/dataset collection |
| publisher required | string Dataset publisher |
| publicationYear required | number <double> Year of publication |
| title required | string Title |
| url | string Full URL to the landing page for this DOI |
| abstract required | string Abstract text for published datasets |
| dataDescription required | string Link to description of how to re-use data |
| resourceType required | string e.g. raw/ derived |
| numberOfFiles | number <double> Number of files |
| sizeOfArchive | number <double> Size of archive |
| pidArray required | Array of strings Array of one or more PIDS which make up the published data |
| authors | Array of strings List of Names of authors of the to be published data |
| registeredTime | string <date-time> Time when doi is successfully registered |
| status | string Indication of position in publication workflow e.g. doiRegistered |
| scicatUser | string The username of the user that clicks the publish button in the client |
| thumbnail | string Small, less than 16 MB base 64 image preview of dataset |
| relatedPublications | Array of strings List of URLs pointing to related publications like DOI URLS of journal articles |
| downloadLink | string URL pointing to page from which data can be downloaded |
| createdBy | string Functional or user account name who created this instance |
| updatedBy | string Functional or user account name who last updated this instance |
| createdAt | string <date-time> |
| updatedAt | string <date-time> |
{- "doi": "string",
- "affiliation": "string",
- "creator": [
- "string"
], - "publisher": "string",
- "publicationYear": 0,
- "title": "string",
- "url": "string",
- "abstract": "string",
- "dataDescription": "string",
- "resourceType": "string",
- "numberOfFiles": 0,
- "sizeOfArchive": 0,
- "pidArray": [
- "string"
], - "authors": [
- "string"
], - "registeredTime": "2019-08-24T14:15:22Z",
- "status": "string",
- "scicatUser": "string",
- "thumbnail": "string",
- "relatedPublications": [
- "string"
], - "downloadLink": "string",
- "createdBy": "string",
- "updatedBy": "string",
- "createdAt": "2019-08-24T14:15:22Z",
- "updatedAt": "2019-08-24T14:15:22Z"
}{- "doi": "string",
- "affiliation": "string",
- "creator": [
- "string"
], - "publisher": "string",
- "publicationYear": 0,
- "title": "string",
- "url": "string",
- "abstract": "string",
- "dataDescription": "string",
- "resourceType": "string",
- "numberOfFiles": 0,
- "sizeOfArchive": 0,
- "pidArray": [
- "string"
], - "authors": [
- "string"
], - "registeredTime": "2019-08-24T14:15:22Z",
- "status": "string",
- "scicatUser": "string",
- "thumbnail": "string",
- "relatedPublications": [
- "string"
], - "downloadLink": "string",
- "createdBy": "string",
- "updatedBy": "string",
- "createdAt": "2019-08-24T14:15:22Z",
- "updatedAt": "2019-08-24T14:15:22Z"
}Model instance data
| doi required | string Digital Object Identifier |
| affiliation | string Creator Affiliation |
| creator required | Array of strings Creator of dataset/dataset collection |
| publisher required | string Dataset publisher |
| publicationYear required | number <double> Year of publication |
| title required | string Title |
| url | string Full URL to the landing page for this DOI |
| abstract required | string Abstract text for published datasets |
| dataDescription required | string Link to description of how to re-use data |
| resourceType required | string e.g. raw/ derived |
| numberOfFiles | number <double> Number of files |
| sizeOfArchive | number <double> Size of archive |
| pidArray required | Array of strings Array of one or more PIDS which make up the published data |
| authors | Array of strings List of Names of authors of the to be published data |
| registeredTime | string <date-time> Time when doi is successfully registered |
| status | string Indication of position in publication workflow e.g. doiRegistered |
| scicatUser | string The username of the user that clicks the publish button in the client |
| thumbnail | string Small, less than 16 MB base 64 image preview of dataset |
| relatedPublications | Array of strings List of URLs pointing to related publications like DOI URLS of journal articles |
| downloadLink | string URL pointing to page from which data can be downloaded |
| createdBy | string Functional or user account name who created this instance |
| updatedBy | string Functional or user account name who last updated this instance |
| createdAt | string <date-time> |
| updatedAt | string <date-time> |
{- "doi": "string",
- "affiliation": "string",
- "creator": [
- "string"
], - "publisher": "string",
- "publicationYear": 0,
- "title": "string",
- "url": "string",
- "abstract": "string",
- "dataDescription": "string",
- "resourceType": "string",
- "numberOfFiles": 0,
- "sizeOfArchive": 0,
- "pidArray": [
- "string"
], - "authors": [
- "string"
], - "registeredTime": "2019-08-24T14:15:22Z",
- "status": "string",
- "scicatUser": "string",
- "thumbnail": "string",
- "relatedPublications": [
- "string"
], - "downloadLink": "string",
- "createdBy": "string",
- "updatedBy": "string",
- "createdAt": "2019-08-24T14:15:22Z",
- "updatedAt": "2019-08-24T14:15:22Z"
}{- "doi": "string",
- "affiliation": "string",
- "creator": [
- "string"
], - "publisher": "string",
- "publicationYear": 0,
- "title": "string",
- "url": "string",
- "abstract": "string",
- "dataDescription": "string",
- "resourceType": "string",
- "numberOfFiles": 0,
- "sizeOfArchive": 0,
- "pidArray": [
- "string"
], - "authors": [
- "string"
], - "registeredTime": "2019-08-24T14:15:22Z",
- "status": "string",
- "scicatUser": "string",
- "thumbnail": "string",
- "relatedPublications": [
- "string"
], - "downloadLink": "string",
- "createdBy": "string",
- "updatedBy": "string",
- "createdAt": "2019-08-24T14:15:22Z",
- "updatedAt": "2019-08-24T14:15:22Z"
}| filter | string <JSON> Filter defining fields, where, include, order, offset, and limit - must be a JSON-encoded string ( |
[- {
- "doi": "string",
- "affiliation": "string",
- "creator": [
- "string"
], - "publisher": "string",
- "publicationYear": 0,
- "title": "string",
- "url": "string",
- "abstract": "string",
- "dataDescription": "string",
- "resourceType": "string",
- "numberOfFiles": 0,
- "sizeOfArchive": 0,
- "pidArray": [
- "string"
], - "authors": [
- "string"
], - "registeredTime": "2019-08-24T14:15:22Z",
- "status": "string",
- "scicatUser": "string",
- "thumbnail": "string",
- "relatedPublications": [
- "string"
], - "downloadLink": "string",
- "createdBy": "string",
- "updatedBy": "string",
- "createdAt": "2019-08-24T14:15:22Z",
- "updatedAt": "2019-08-24T14:15:22Z"
}
]Model instance data
| doi required | string Digital Object Identifier |
| affiliation | string Creator Affiliation |
| creator required | Array of strings Creator of dataset/dataset collection |
| publisher required | string Dataset publisher |
| publicationYear required | number <double> Year of publication |
| title required | string Title |
| url | string Full URL to the landing page for this DOI |
| abstract required | string Abstract text for published datasets |
| dataDescription required | string Link to description of how to re-use data |
| resourceType required | string e.g. raw/ derived |
| numberOfFiles | number <double> Number of files |
| sizeOfArchive | number <double> Size of archive |
| pidArray required | Array of strings Array of one or more PIDS which make up the published data |
| authors | Array of strings List of Names of authors of the to be published data |
| registeredTime | string <date-time> Time when doi is successfully registered |
| status | string Indication of position in publication workflow e.g. doiRegistered |
| scicatUser | string The username of the user that clicks the publish button in the client |
| thumbnail | string Small, less than 16 MB base 64 image preview of dataset |
| relatedPublications | Array of strings List of URLs pointing to related publications like DOI URLS of journal articles |
| downloadLink | string URL pointing to page from which data can be downloaded |
| createdBy | string Functional or user account name who created this instance |
| updatedBy | string Functional or user account name who last updated this instance |
| createdAt | string <date-time> |
| updatedAt | string <date-time> |
{- "doi": "string",
- "affiliation": "string",
- "creator": [
- "string"
], - "publisher": "string",
- "publicationYear": 0,
- "title": "string",
- "url": "string",
- "abstract": "string",
- "dataDescription": "string",
- "resourceType": "string",
- "numberOfFiles": 0,
- "sizeOfArchive": 0,
- "pidArray": [
- "string"
], - "authors": [
- "string"
], - "registeredTime": "2019-08-24T14:15:22Z",
- "status": "string",
- "scicatUser": "string",
- "thumbnail": "string",
- "relatedPublications": [
- "string"
], - "downloadLink": "string",
- "createdBy": "string",
- "updatedBy": "string",
- "createdAt": "2019-08-24T14:15:22Z",
- "updatedAt": "2019-08-24T14:15:22Z"
}{- "doi": "string",
- "affiliation": "string",
- "creator": [
- "string"
], - "publisher": "string",
- "publicationYear": 0,
- "title": "string",
- "url": "string",
- "abstract": "string",
- "dataDescription": "string",
- "resourceType": "string",
- "numberOfFiles": 0,
- "sizeOfArchive": 0,
- "pidArray": [
- "string"
], - "authors": [
- "string"
], - "registeredTime": "2019-08-24T14:15:22Z",
- "status": "string",
- "scicatUser": "string",
- "thumbnail": "string",
- "relatedPublications": [
- "string"
], - "downloadLink": "string",
- "createdBy": "string",
- "updatedBy": "string",
- "createdAt": "2019-08-24T14:15:22Z",
- "updatedAt": "2019-08-24T14:15:22Z"
}| where | string <JSON> Criteria to match model instances |
An object of model property name/value pairs
| doi required | string Digital Object Identifier |
| affiliation | string Creator Affiliation |
| creator required | Array of strings Creator of dataset/dataset collection |
| publisher required | string Dataset publisher |
| publicationYear required | number <double> Year of publication |
| title required | string Title |
| url | string Full URL to the landing page for this DOI |
| abstract required | string Abstract text for published datasets |
| dataDescription required | string Link to description of how to re-use data |
| resourceType required | string e.g. raw/ derived |
| numberOfFiles | number <double> Number of files |
| sizeOfArchive | number <double> Size of archive |
| pidArray required | Array of strings Array of one or more PIDS which make up the published data |
| authors | Array of strings List of Names of authors of the to be published data |
| registeredTime | string <date-time> Time when doi is successfully registered |
| status | string Indication of position in publication workflow e.g. doiRegistered |
| scicatUser | string The username of the user that clicks the publish button in the client |
| thumbnail | string Small, less than 16 MB base 64 image preview of dataset |
| relatedPublications | Array of strings List of URLs pointing to related publications like DOI URLS of journal articles |
| downloadLink | string URL pointing to page from which data can be downloaded |
| createdBy | string Functional or user account name who created this instance |
| updatedBy | string Functional or user account name who last updated this instance |
| createdAt | string <date-time> |
| updatedAt | string <date-time> |
{- "doi": "string",
- "affiliation": "string",
- "creator": [
- "string"
], - "publisher": "string",
- "publicationYear": 0,
- "title": "string",
- "url": "string",
- "abstract": "string",
- "dataDescription": "string",
- "resourceType": "string",
- "numberOfFiles": 0,
- "sizeOfArchive": 0,
- "pidArray": [
- "string"
], - "authors": [
- "string"
], - "registeredTime": "2019-08-24T14:15:22Z",
- "status": "string",
- "scicatUser": "string",
- "thumbnail": "string",
- "relatedPublications": [
- "string"
], - "downloadLink": "string",
- "createdBy": "string",
- "updatedBy": "string",
- "createdAt": "2019-08-24T14:15:22Z",
- "updatedAt": "2019-08-24T14:15:22Z"
}{- "doi": "string",
- "affiliation": "string",
- "creator": [
- "string"
], - "publisher": "string",
- "publicationYear": 0,
- "title": "string",
- "url": "string",
- "abstract": "string",
- "dataDescription": "string",
- "resourceType": "string",
- "numberOfFiles": 0,
- "sizeOfArchive": 0,
- "pidArray": [
- "string"
], - "authors": [
- "string"
], - "registeredTime": "2019-08-24T14:15:22Z",
- "status": "string",
- "scicatUser": "string",
- "thumbnail": "string",
- "relatedPublications": [
- "string"
], - "downloadLink": "string",
- "createdBy": "string",
- "updatedBy": "string",
- "createdAt": "2019-08-24T14:15:22Z",
- "updatedAt": "2019-08-24T14:15:22Z"
}| id required | string <JSON> Model id |
| filter | string <JSON> Filter defining fields and include - must be a JSON-encoded string ({"something":"value"}) |
{- "doi": "string",
- "affiliation": "string",
- "creator": [
- "string"
], - "publisher": "string",
- "publicationYear": 0,
- "title": "string",
- "url": "string",
- "abstract": "string",
- "dataDescription": "string",
- "resourceType": "string",
- "numberOfFiles": 0,
- "sizeOfArchive": 0,
- "pidArray": [
- "string"
], - "authors": [
- "string"
], - "registeredTime": "2019-08-24T14:15:22Z",
- "status": "string",
- "scicatUser": "string",
- "thumbnail": "string",
- "relatedPublications": [
- "string"
], - "downloadLink": "string",
- "createdBy": "string",
- "updatedBy": "string",
- "createdAt": "2019-08-24T14:15:22Z",
- "updatedAt": "2019-08-24T14:15:22Z"
}| id required | string <JSON> Model id |
Model instance data
| doi required | string Digital Object Identifier |
| affiliation | string Creator Affiliation |
| creator required | Array of strings Creator of dataset/dataset collection |
| publisher required | string Dataset publisher |
| publicationYear required | number <double> Year of publication |
| title required | string Title |
| url | string Full URL to the landing page for this DOI |
| abstract required | string Abstract text for published datasets |
| dataDescription required | string Link to description of how to re-use data |
| resourceType required | string e.g. raw/ derived |
| numberOfFiles | number <double> Number of files |
| sizeOfArchive | number <double> Size of archive |
| pidArray required | Array of strings Array of one or more PIDS which make up the published data |
| authors | Array of strings List of Names of authors of the to be published data |
| registeredTime | string <date-time> Time when doi is successfully registered |
| status | string Indication of position in publication workflow e.g. doiRegistered |
| scicatUser | string The username of the user that clicks the publish button in the client |
| thumbnail | string Small, less than 16 MB base 64 image preview of dataset |
| relatedPublications | Array of strings List of URLs pointing to related publications like DOI URLS of journal articles |
| downloadLink | string URL pointing to page from which data can be downloaded |
| createdBy | string Functional or user account name who created this instance |
| updatedBy | string Functional or user account name who last updated this instance |
| createdAt | string <date-time> |
| updatedAt | string <date-time> |
{- "doi": "string",
- "affiliation": "string",
- "creator": [
- "string"
], - "publisher": "string",
- "publicationYear": 0,
- "title": "string",
- "url": "string",
- "abstract": "string",
- "dataDescription": "string",
- "resourceType": "string",
- "numberOfFiles": 0,
- "sizeOfArchive": 0,
- "pidArray": [
- "string"
], - "authors": [
- "string"
], - "registeredTime": "2019-08-24T14:15:22Z",
- "status": "string",
- "scicatUser": "string",
- "thumbnail": "string",
- "relatedPublications": [
- "string"
], - "downloadLink": "string",
- "createdBy": "string",
- "updatedBy": "string",
- "createdAt": "2019-08-24T14:15:22Z",
- "updatedAt": "2019-08-24T14:15:22Z"
}{- "doi": "string",
- "affiliation": "string",
- "creator": [
- "string"
], - "publisher": "string",
- "publicationYear": 0,
- "title": "string",
- "url": "string",
- "abstract": "string",
- "dataDescription": "string",
- "resourceType": "string",
- "numberOfFiles": 0,
- "sizeOfArchive": 0,
- "pidArray": [
- "string"
], - "authors": [
- "string"
], - "registeredTime": "2019-08-24T14:15:22Z",
- "status": "string",
- "scicatUser": "string",
- "thumbnail": "string",
- "relatedPublications": [
- "string"
], - "downloadLink": "string",
- "createdBy": "string",
- "updatedBy": "string",
- "createdAt": "2019-08-24T14:15:22Z",
- "updatedAt": "2019-08-24T14:15:22Z"
}| id required | string <JSON> PublishedData id |
An object of model property name/value pairs
| doi required | string Digital Object Identifier |
| affiliation | string Creator Affiliation |
| creator required | Array of strings Creator of dataset/dataset collection |
| publisher required | string Dataset publisher |
| publicationYear required | number <double> Year of publication |
| title required | string Title |
| url | string Full URL to the landing page for this DOI |
| abstract required | string Abstract text for published datasets |
| dataDescription required | string Link to description of how to re-use data |
| resourceType required | string e.g. raw/ derived |
| numberOfFiles | number <double> Number of files |
| sizeOfArchive | number <double> Size of archive |
| pidArray required | Array of strings Array of one or more PIDS which make up the published data |
| authors | Array of strings List of Names of authors of the to be published data |
| registeredTime | string <date-time> Time when doi is successfully registered |
| status | string Indication of position in publication workflow e.g. doiRegistered |
| scicatUser | string The username of the user that clicks the publish button in the client |
| thumbnail | string Small, less than 16 MB base 64 image preview of dataset |
| relatedPublications | Array of strings List of URLs pointing to related publications like DOI URLS of journal articles |
| downloadLink | string URL pointing to page from which data can be downloaded |
| createdBy | string Functional or user account name who created this instance |
| updatedBy | string Functional or user account name who last updated this instance |
| createdAt | string <date-time> |
| updatedAt | string <date-time> |
{- "doi": "string",
- "affiliation": "string",
- "creator": [
- "string"
], - "publisher": "string",
- "publicationYear": 0,
- "title": "string",
- "url": "string",
- "abstract": "string",
- "dataDescription": "string",
- "resourceType": "string",
- "numberOfFiles": 0,
- "sizeOfArchive": 0,
- "pidArray": [
- "string"
], - "authors": [
- "string"
], - "registeredTime": "2019-08-24T14:15:22Z",
- "status": "string",
- "scicatUser": "string",
- "thumbnail": "string",
- "relatedPublications": [
- "string"
], - "downloadLink": "string",
- "createdBy": "string",
- "updatedBy": "string",
- "createdAt": "2019-08-24T14:15:22Z",
- "updatedAt": "2019-08-24T14:15:22Z"
}{- "doi": "string",
- "affiliation": "string",
- "creator": [
- "string"
], - "publisher": "string",
- "publicationYear": 0,
- "title": "string",
- "url": "string",
- "abstract": "string",
- "dataDescription": "string",
- "resourceType": "string",
- "numberOfFiles": 0,
- "sizeOfArchive": 0,
- "pidArray": [
- "string"
], - "authors": [
- "string"
], - "registeredTime": "2019-08-24T14:15:22Z",
- "status": "string",
- "scicatUser": "string",
- "thumbnail": "string",
- "relatedPublications": [
- "string"
], - "downloadLink": "string",
- "createdBy": "string",
- "updatedBy": "string",
- "createdAt": "2019-08-24T14:15:22Z",
- "updatedAt": "2019-08-24T14:15:22Z"
}| id required | string <JSON> Model id |
Model instance data
| doi required | string Digital Object Identifier |
| affiliation | string Creator Affiliation |
| creator required | Array of strings Creator of dataset/dataset collection |
| publisher required | string Dataset publisher |
| publicationYear required | number <double> Year of publication |
| title required | string Title |
| url | string Full URL to the landing page for this DOI |
| abstract required | string Abstract text for published datasets |
| dataDescription required | string Link to description of how to re-use data |
| resourceType required | string e.g. raw/ derived |
| numberOfFiles | number <double> Number of files |
| sizeOfArchive | number <double> Size of archive |
| pidArray required | Array of strings Array of one or more PIDS which make up the published data |
| authors | Array of strings List of Names of authors of the to be published data |
| registeredTime | string <date-time> Time when doi is successfully registered |
| status | string Indication of position in publication workflow e.g. doiRegistered |
| scicatUser | string The username of the user that clicks the publish button in the client |
| thumbnail | string Small, less than 16 MB base 64 image preview of dataset |
| relatedPublications | Array of strings List of URLs pointing to related publications like DOI URLS of journal articles |
| downloadLink | string URL pointing to page from which data can be downloaded |
| createdBy | string Functional or user account name who created this instance |
| updatedBy | string Functional or user account name who last updated this instance |
| createdAt | string <date-time> |
| updatedAt | string <date-time> |
{- "doi": "string",
- "affiliation": "string",
- "creator": [
- "string"
], - "publisher": "string",
- "publicationYear": 0,
- "title": "string",
- "url": "string",
- "abstract": "string",
- "dataDescription": "string",
- "resourceType": "string",
- "numberOfFiles": 0,
- "sizeOfArchive": 0,
- "pidArray": [
- "string"
], - "authors": [
- "string"
], - "registeredTime": "2019-08-24T14:15:22Z",
- "status": "string",
- "scicatUser": "string",
- "thumbnail": "string",
- "relatedPublications": [
- "string"
], - "downloadLink": "string",
- "createdBy": "string",
- "updatedBy": "string",
- "createdAt": "2019-08-24T14:15:22Z",
- "updatedAt": "2019-08-24T14:15:22Z"
}{- "doi": "string",
- "affiliation": "string",
- "creator": [
- "string"
], - "publisher": "string",
- "publicationYear": 0,
- "title": "string",
- "url": "string",
- "abstract": "string",
- "dataDescription": "string",
- "resourceType": "string",
- "numberOfFiles": 0,
- "sizeOfArchive": 0,
- "pidArray": [
- "string"
], - "authors": [
- "string"
], - "registeredTime": "2019-08-24T14:15:22Z",
- "status": "string",
- "scicatUser": "string",
- "thumbnail": "string",
- "relatedPublications": [
- "string"
], - "downloadLink": "string",
- "createdBy": "string",
- "updatedBy": "string",
- "createdAt": "2019-08-24T14:15:22Z",
- "updatedAt": "2019-08-24T14:15:22Z"
}| filter | string <JSON> Filter defining fields, where, include, order, offset, and limit - must be a JSON-encoded string ( |
{- "doi": "string",
- "affiliation": "string",
- "creator": [
- "string"
], - "publisher": "string",
- "publicationYear": 0,
- "title": "string",
- "url": "string",
- "abstract": "string",
- "dataDescription": "string",
- "resourceType": "string",
- "numberOfFiles": 0,
- "sizeOfArchive": 0,
- "pidArray": [
- "string"
], - "authors": [
- "string"
], - "registeredTime": "2019-08-24T14:15:22Z",
- "status": "string",
- "scicatUser": "string",
- "thumbnail": "string",
- "relatedPublications": [
- "string"
], - "downloadLink": "string",
- "createdBy": "string",
- "updatedBy": "string",
- "createdAt": "2019-08-24T14:15:22Z",
- "updatedAt": "2019-08-24T14:15:22Z"
}| where | string <JSON> Criteria to match model instances |
An object of model property name/value pairs
| doi required | string Digital Object Identifier |
| affiliation | string Creator Affiliation |
| creator required | Array of strings Creator of dataset/dataset collection |
| publisher required | string Dataset publisher |
| publicationYear required | number <double> Year of publication |
| title required | string Title |
| url | string Full URL to the landing page for this DOI |
| abstract required | string Abstract text for published datasets |
| dataDescription required | string Link to description of how to re-use data |
| resourceType required | string e.g. raw/ derived |
| numberOfFiles | number <double> Number of files |
| sizeOfArchive | number <double> Size of archive |
| pidArray required | Array of strings Array of one or more PIDS which make up the published data |
| authors | Array of strings List of Names of authors of the to be published data |
| registeredTime | string <date-time> Time when doi is successfully registered |
| status | string Indication of position in publication workflow e.g. doiRegistered |
| scicatUser | string The username of the user that clicks the publish button in the client |
| thumbnail | string Small, less than 16 MB base 64 image preview of dataset |
| relatedPublications | Array of strings List of URLs pointing to related publications like DOI URLS of journal articles |
| downloadLink | string URL pointing to page from which data can be downloaded |
| createdBy | string Functional or user account name who created this instance |
| updatedBy | string Functional or user account name who last updated this instance |
| createdAt | string <date-time> |
| updatedAt | string <date-time> |
{- "doi": "string",
- "affiliation": "string",
- "creator": [
- "string"
], - "publisher": "string",
- "publicationYear": 0,
- "title": "string",
- "url": "string",
- "abstract": "string",
- "dataDescription": "string",
- "resourceType": "string",
- "numberOfFiles": 0,
- "sizeOfArchive": 0,
- "pidArray": [
- "string"
], - "authors": [
- "string"
], - "registeredTime": "2019-08-24T14:15:22Z",
- "status": "string",
- "scicatUser": "string",
- "thumbnail": "string",
- "relatedPublications": [
- "string"
], - "downloadLink": "string",
- "createdBy": "string",
- "updatedBy": "string",
- "createdAt": "2019-08-24T14:15:22Z",
- "updatedAt": "2019-08-24T14:15:22Z"
}{- "count": 0
}| id required | string |
| doi required | string Digital Object Identifier |
| affiliation | string Creator Affiliation |
| creator required | Array of strings Creator of dataset/dataset collection |
| publisher required | string Dataset publisher |
| publicationYear required | number <double> Year of publication |
| title required | string Title |
| url | string Full URL to the landing page for this DOI |
| abstract required | string Abstract text for published datasets |
| dataDescription required | string Link to description of how to re-use data |
| resourceType required | string e.g. raw/ derived |
| numberOfFiles | number <double> Number of files |
| sizeOfArchive | number <double> Size of archive |
| pidArray required | Array of strings Array of one or more PIDS which make up the published data |
| authors | Array of strings List of Names of authors of the to be published data |
| registeredTime | string <date-time> Time when doi is successfully registered |
| status | string Indication of position in publication workflow e.g. doiRegistered |
| scicatUser | string The username of the user that clicks the publish button in the client |
| thumbnail | string Small, less than 16 MB base 64 image preview of dataset |
| relatedPublications | Array of strings List of URLs pointing to related publications like DOI URLS of journal articles |
| downloadLink | string URL pointing to page from which data can be downloaded |
| createdBy | string Functional or user account name who created this instance |
| updatedBy | string Functional or user account name who last updated this instance |
| createdAt | string <date-time> |
| updatedAt | string <date-time> |
{- "doi": "string",
- "affiliation": "string",
- "creator": [
- "string"
], - "publisher": "string",
- "publicationYear": 0,
- "title": "string",
- "url": "string",
- "abstract": "string",
- "dataDescription": "string",
- "resourceType": "string",
- "numberOfFiles": 0,
- "sizeOfArchive": 0,
- "pidArray": [
- "string"
], - "authors": [
- "string"
], - "registeredTime": "2019-08-24T14:15:22Z",
- "status": "string",
- "scicatUser": "string",
- "thumbnail": "string",
- "relatedPublications": [
- "string"
], - "downloadLink": "string",
- "createdBy": "string",
- "updatedBy": "string",
- "createdAt": "2019-08-24T14:15:22Z",
- "updatedAt": "2019-08-24T14:15:22Z"
}{- "doi": "string"
}When archiving a dataset all files contained in the dataset are listed here together with their checksum information. Several datablocks can be created if the file listing is too long for a single datablock. This partitioning decision is done by the archiving system to allow for chunks of datablocks with managable sizes. E.g a dataset consisting of 10 TB of data could be split into 10 datablocks of about 1 TB each. The upper limit set by the data catalog system itself is given by the fact that documents must be smaller than 16 MB, which typically allows for datasets of about 100000 files.
| id required | string <JSON> Datablock id |
| refresh | boolean |
{- "pid": "string",
- "owner": "string",
- "ownerEmail": "string",
- "orcidOfOwner": "string",
- "contactEmail": "string",
- "sourceFolder": "string",
- "sourceFolderHost": "string",
- "size": 0,
- "packedSize": 0,
- "numberOfFiles": 0,
- "numberOfFilesArchived": 0,
- "creationTime": "2019-08-24T14:15:22Z",
- "type": "string",
- "validationStatus": "string",
- "keywords": [
- "string"
], - "description": "string",
- "datasetName": "string",
- "classification": "string",
- "license": "string",
- "version": "string",
- "isPublished": true,
- "ownerGroup": "string",
- "accessGroups": [
- "string"
], - "createdBy": "string",
- "updatedBy": "string",
- "createdAt": "2019-08-24T14:15:22Z",
- "updatedAt": "2019-08-24T14:15:22Z",
- "publishedDataId": "string",
- "publisheddataId": "string",
- "datasetlifecycle": {
- "archivable": true,
- "retrievable": true,
- "publishable": true,
- "dateOfDiskPurging": "2019-08-24T14:15:22Z",
- "archiveRetentionTime": "2019-08-24T14:15:22Z",
- "dateOfPublishing": "2019-08-24T14:15:22Z",
- "isOnCentralDisk": true,
- "archiveStatusMessage": "string",
- "retrieveStatusMessage": "string",
- "archiveReturnMessage": { },
- "retrieveReturnMessage": { },
- "exportedTo": "string",
- "retrieveIntegrityCheck": true,
- "id": "string"
}, - "history": [
- {
- "id": "string"
}
], - "instrumentId": "string",
- "techniques": [
- {
- "pid": "string",
- "name": "string"
}
]
}Model instance data
| id required | string Catalog internal UUIDv4 for datablock |
| archiveId required | string Unique identifier given bey archive system to the stored datablock. This id is used when data is retrieved back. |
| size required | number <double> Total size in bytes of all files in datablock when unpacked |
| packedSize | number <double> Size of datablock package file |
| chkAlg | string Algoritm used for calculation of checksums, e.g. sha2 |
| version required | string Version string defining format of how data is packed and stored in archive |
required | Array of objects (Datafile) |
| ownerGroup required | string Defines the group which owns the data, and therefore has unrestricted access to this data. Usually a pgroup like p12151 |
| accessGroups | Array of strings Optional additional groups which have read access to the data. Users which are member in one of the groups listed here are allowed to access this data. The special group 'public' makes data available to all users |
| createdBy | string Functional or user account name who created this instance |
| updatedBy | string Functional or user account name who last updated this instance |
| datasetId | string |
| rawDatasetId | string |
| derivedDatasetId | string |
| createdAt | string <date-time> |
| updatedAt | string <date-time> |
{- "id": "string",
- "archiveId": "string",
- "size": 0,
- "packedSize": 0,
- "chkAlg": "string",
- "version": "string",
- "dataFileList": [
- {
- "path": "string",
- "size": 0,
- "time": "2019-08-24T14:15:22Z",
- "chk": "string",
- "uid": "string",
- "gid": "string",
- "perm": "string"
}
], - "ownerGroup": "string",
- "accessGroups": [
- "string"
], - "createdBy": "string",
- "updatedBy": "string",
- "datasetId": "string",
- "rawDatasetId": "string",
- "derivedDatasetId": "string",
- "createdAt": "2019-08-24T14:15:22Z",
- "updatedAt": "2019-08-24T14:15:22Z"
}{- "id": "string",
- "archiveId": "string",
- "size": 0,
- "packedSize": 0,
- "chkAlg": "string",
- "version": "string",
- "dataFileList": [
- {
- "path": "string",
- "size": 0,
- "time": "2019-08-24T14:15:22Z",
- "chk": "string",
- "uid": "string",
- "gid": "string",
- "perm": "string"
}
], - "ownerGroup": "string",
- "accessGroups": [
- "string"
], - "createdBy": "string",
- "updatedBy": "string",
- "datasetId": "string",
- "rawDatasetId": "string",
- "derivedDatasetId": "string",
- "createdAt": "2019-08-24T14:15:22Z",
- "updatedAt": "2019-08-24T14:15:22Z"
}Model instance data
| id required | string Catalog internal UUIDv4 for datablock |
| archiveId required | string Unique identifier given bey archive system to the stored datablock. This id is used when data is retrieved back. |
| size required | number <double> Total size in bytes of all files in datablock when unpacked |
| packedSize | number <double> Size of datablock package file |
| chkAlg | string Algoritm used for calculation of checksums, e.g. sha2 |
| version required | string Version string defining format of how data is packed and stored in archive |
required | Array of objects (Datafile) |
| ownerGroup required | string Defines the group which owns the data, and therefore has unrestricted access to this data. Usually a pgroup like p12151 |
| accessGroups | Array of strings Optional additional groups which have read access to the data. Users which are member in one of the groups listed here are allowed to access this data. The special group 'public' makes data available to all users |
| createdBy | string Functional or user account name who created this instance |
| updatedBy | string Functional or user account name who last updated this instance |
| datasetId | string |
| rawDatasetId | string |
| derivedDatasetId | string |
| createdAt | string <date-time> |
| updatedAt | string <date-time> |
{- "id": "string",
- "archiveId": "string",
- "size": 0,
- "packedSize": 0,
- "chkAlg": "string",
- "version": "string",
- "dataFileList": [
- {
- "path": "string",
- "size": 0,
- "time": "2019-08-24T14:15:22Z",
- "chk": "string",
- "uid": "string",
- "gid": "string",
- "perm": "string"
}
], - "ownerGroup": "string",
- "accessGroups": [
- "string"
], - "createdBy": "string",
- "updatedBy": "string",
- "datasetId": "string",
- "rawDatasetId": "string",
- "derivedDatasetId": "string",
- "createdAt": "2019-08-24T14:15:22Z",
- "updatedAt": "2019-08-24T14:15:22Z"
}{- "id": "string",
- "archiveId": "string",
- "size": 0,
- "packedSize": 0,
- "chkAlg": "string",
- "version": "string",
- "dataFileList": [
- {
- "path": "string",
- "size": 0,
- "time": "2019-08-24T14:15:22Z",
- "chk": "string",
- "uid": "string",
- "gid": "string",
- "perm": "string"
}
], - "ownerGroup": "string",
- "accessGroups": [
- "string"
], - "createdBy": "string",
- "updatedBy": "string",
- "datasetId": "string",
- "rawDatasetId": "string",
- "derivedDatasetId": "string",
- "createdAt": "2019-08-24T14:15:22Z",
- "updatedAt": "2019-08-24T14:15:22Z"
}Model instance data
| id required | string Catalog internal UUIDv4 for datablock |
| archiveId required | string Unique identifier given bey archive system to the stored datablock. This id is used when data is retrieved back. |
| size required | number <double> Total size in bytes of all files in datablock when unpacked |
| packedSize | number <double> Size of datablock package file |
| chkAlg | string Algoritm used for calculation of checksums, e.g. sha2 |
| version required | string Version string defining format of how data is packed and stored in archive |
required | Array of objects (Datafile) |
| ownerGroup required | string Defines the group which owns the data, and therefore has unrestricted access to this data. Usually a pgroup like p12151 |
| accessGroups | Array of strings Optional additional groups which have read access to the data. Users which are member in one of the groups listed here are allowed to access this data. The special group 'public' makes data available to all users |
| createdBy | string Functional or user account name who created this instance |
| updatedBy | string Functional or user account name who last updated this instance |
| datasetId | string |
| rawDatasetId | string |
| derivedDatasetId | string |
| createdAt | string <date-time> |
| updatedAt | string <date-time> |
{- "id": "string",
- "archiveId": "string",
- "size": 0,
- "packedSize": 0,
- "chkAlg": "string",
- "version": "string",
- "dataFileList": [
- {
- "path": "string",
- "size": 0,
- "time": "2019-08-24T14:15:22Z",
- "chk": "string",
- "uid": "string",
- "gid": "string",
- "perm": "string"
}
], - "ownerGroup": "string",
- "accessGroups": [
- "string"
], - "createdBy": "string",
- "updatedBy": "string",
- "datasetId": "string",
- "rawDatasetId": "string",
- "derivedDatasetId": "string",
- "createdAt": "2019-08-24T14:15:22Z",
- "updatedAt": "2019-08-24T14:15:22Z"
}{- "id": "string",
- "archiveId": "string",
- "size": 0,
- "packedSize": 0,
- "chkAlg": "string",
- "version": "string",
- "dataFileList": [
- {
- "path": "string",
- "size": 0,
- "time": "2019-08-24T14:15:22Z",
- "chk": "string",
- "uid": "string",
- "gid": "string",
- "perm": "string"
}
], - "ownerGroup": "string",
- "accessGroups": [
- "string"
], - "createdBy": "string",
- "updatedBy": "string",
- "datasetId": "string",
- "rawDatasetId": "string",
- "derivedDatasetId": "string",
- "createdAt": "2019-08-24T14:15:22Z",
- "updatedAt": "2019-08-24T14:15:22Z"
}| filter | string <JSON> Filter defining fields, where, include, order, offset, and limit - must be a JSON-encoded string ( |
[- {
- "id": "string",
- "archiveId": "string",
- "size": 0,
- "packedSize": 0,
- "chkAlg": "string",
- "version": "string",
- "dataFileList": [
- {
- "path": "string",
- "size": 0,
- "time": "2019-08-24T14:15:22Z",
- "chk": "string",
- "uid": "string",
- "gid": "string",
- "perm": "string"
}
], - "ownerGroup": "string",
- "accessGroups": [
- "string"
], - "createdBy": "string",
- "updatedBy": "string",
- "datasetId": "string",
- "rawDatasetId": "string",
- "derivedDatasetId": "string",
- "createdAt": "2019-08-24T14:15:22Z",
- "updatedAt": "2019-08-24T14:15:22Z"
}
]Model instance data
| id required | string Catalog internal UUIDv4 for datablock |
| archiveId required | string Unique identifier given bey archive system to the stored datablock. This id is used when data is retrieved back. |
| size required | number <double> Total size in bytes of all files in datablock when unpacked |
| packedSize | number <double> Size of datablock package file |
| chkAlg | string Algoritm used for calculation of checksums, e.g. sha2 |
| version required | string Version string defining format of how data is packed and stored in archive |
required | Array of objects (Datafile) |
| ownerGroup required | string Defines the group which owns the data, and therefore has unrestricted access to this data. Usually a pgroup like p12151 |
| accessGroups | Array of strings Optional additional groups which have read access to the data. Users which are member in one of the groups listed here are allowed to access this data. The special group 'public' makes data available to all users |
| createdBy | string Functional or user account name who created this instance |
| updatedBy | string Functional or user account name who last updated this instance |
| datasetId | string |
| rawDatasetId | string |
| derivedDatasetId | string |
| createdAt | string <date-time> |
| updatedAt | string <date-time> |
{- "id": "string",
- "archiveId": "string",
- "size": 0,
- "packedSize": 0,
- "chkAlg": "string",
- "version": "string",
- "dataFileList": [
- {
- "path": "string",
- "size": 0,
- "time": "2019-08-24T14:15:22Z",
- "chk": "string",
- "uid": "string",
- "gid": "string",
- "perm": "string"
}
], - "ownerGroup": "string",
- "accessGroups": [
- "string"
], - "createdBy": "string",
- "updatedBy": "string",
- "datasetId": "string",
- "rawDatasetId": "string",
- "derivedDatasetId": "string",
- "createdAt": "2019-08-24T14:15:22Z",
- "updatedAt": "2019-08-24T14:15:22Z"
}{- "id": "string",
- "archiveId": "string",
- "size": 0,
- "packedSize": 0,
- "chkAlg": "string",
- "version": "string",
- "dataFileList": [
- {
- "path": "string",
- "size": 0,
- "time": "2019-08-24T14:15:22Z",
- "chk": "string",
- "uid": "string",
- "gid": "string",
- "perm": "string"
}
], - "ownerGroup": "string",
- "accessGroups": [
- "string"
], - "createdBy": "string",
- "updatedBy": "string",
- "datasetId": "string",
- "rawDatasetId": "string",
- "derivedDatasetId": "string",
- "createdAt": "2019-08-24T14:15:22Z",
- "updatedAt": "2019-08-24T14:15:22Z"
}| where | string <JSON> Criteria to match model instances |
An object of model property name/value pairs
| id required | string Catalog internal UUIDv4 for datablock |
| archiveId required | string Unique identifier given bey archive system to the stored datablock. This id is used when data is retrieved back. |
| size required | number <double> Total size in bytes of all files in datablock when unpacked |
| packedSize | number <double> Size of datablock package file |
| chkAlg | string Algoritm used for calculation of checksums, e.g. sha2 |
| version required | string Version string defining format of how data is packed and stored in archive |
required | Array of objects (Datafile) |
| ownerGroup required | string Defines the group which owns the data, and therefore has unrestricted access to this data. Usually a pgroup like p12151 |
| accessGroups | Array of strings Optional additional groups which have read access to the data. Users which are member in one of the groups listed here are allowed to access this data. The special group 'public' makes data available to all users |
| createdBy | string Functional or user account name who created this instance |
| updatedBy | string Functional or user account name who last updated this instance |
| datasetId | string |
| rawDatasetId | string |
| derivedDatasetId | string |
| createdAt | string <date-time> |
| updatedAt | string <date-time> |
{- "id": "string",
- "archiveId": "string",
- "size": 0,
- "packedSize": 0,
- "chkAlg": "string",
- "version": "string",
- "dataFileList": [
- {
- "path": "string",
- "size": 0,
- "time": "2019-08-24T14:15:22Z",
- "chk": "string",
- "uid": "string",
- "gid": "string",
- "perm": "string"
}
], - "ownerGroup": "string",
- "accessGroups": [
- "string"
], - "createdBy": "string",
- "updatedBy": "string",
- "datasetId": "string",
- "rawDatasetId": "string",
- "derivedDatasetId": "string",
- "createdAt": "2019-08-24T14:15:22Z",
- "updatedAt": "2019-08-24T14:15:22Z"
}{- "id": "string",
- "archiveId": "string",
- "size": 0,
- "packedSize": 0,
- "chkAlg": "string",
- "version": "string",
- "dataFileList": [
- {
- "path": "string",
- "size": 0,
- "time": "2019-08-24T14:15:22Z",
- "chk": "string",
- "uid": "string",
- "gid": "string",
- "perm": "string"
}
], - "ownerGroup": "string",
- "accessGroups": [
- "string"
], - "createdBy": "string",
- "updatedBy": "string",
- "datasetId": "string",
- "rawDatasetId": "string",
- "derivedDatasetId": "string",
- "createdAt": "2019-08-24T14:15:22Z",
- "updatedAt": "2019-08-24T14:15:22Z"
}| id required | string <JSON> Model id |
| filter | string <JSON> Filter defining fields and include - must be a JSON-encoded string ({"something":"value"}) |
{- "id": "string",
- "archiveId": "string",
- "size": 0,
- "packedSize": 0,
- "chkAlg": "string",
- "version": "string",
- "dataFileList": [
- {
- "path": "string",
- "size": 0,
- "time": "2019-08-24T14:15:22Z",
- "chk": "string",
- "uid": "string",
- "gid": "string",
- "perm": "string"
}
], - "ownerGroup": "string",
- "accessGroups": [
- "string"
], - "createdBy": "string",
- "updatedBy": "string",
- "datasetId": "string",
- "rawDatasetId": "string",
- "derivedDatasetId": "string",
- "createdAt": "2019-08-24T14:15:22Z",
- "updatedAt": "2019-08-24T14:15:22Z"
}| id required | string <JSON> Model id |
Model instance data
| id required | string Catalog internal UUIDv4 for datablock |
| archiveId required | string Unique identifier given bey archive system to the stored datablock. This id is used when data is retrieved back. |
| size required | number <double> Total size in bytes of all files in datablock when unpacked |
| packedSize | number <double> Size of datablock package file |
| chkAlg | string Algoritm used for calculation of checksums, e.g. sha2 |
| version required | string Version string defining format of how data is packed and stored in archive |
required | Array of objects (Datafile) |
| ownerGroup required | string Defines the group which owns the data, and therefore has unrestricted access to this data. Usually a pgroup like p12151 |
| accessGroups | Array of strings Optional additional groups which have read access to the data. Users which are member in one of the groups listed here are allowed to access this data. The special group 'public' makes data available to all users |
| createdBy | string Functional or user account name who created this instance |
| updatedBy | string Functional or user account name who last updated this instance |
| datasetId | string |
| rawDatasetId | string |
| derivedDatasetId | string |
| createdAt | string <date-time> |
| updatedAt | string <date-time> |
{- "id": "string",
- "archiveId": "string",
- "size": 0,
- "packedSize": 0,
- "chkAlg": "string",
- "version": "string",
- "dataFileList": [
- {
- "path": "string",
- "size": 0,
- "time": "2019-08-24T14:15:22Z",
- "chk": "string",
- "uid": "string",
- "gid": "string",
- "perm": "string"
}
], - "ownerGroup": "string",
- "accessGroups": [
- "string"
], - "createdBy": "string",
- "updatedBy": "string",
- "datasetId": "string",
- "rawDatasetId": "string",
- "derivedDatasetId": "string",
- "createdAt": "2019-08-24T14:15:22Z",
- "updatedAt": "2019-08-24T14:15:22Z"
}{- "id": "string",
- "archiveId": "string",
- "size": 0,
- "packedSize": 0,
- "chkAlg": "string",
- "version": "string",
- "dataFileList": [
- {
- "path": "string",
- "size": 0,
- "time": "2019-08-24T14:15:22Z",
- "chk": "string",
- "uid": "string",
- "gid": "string",
- "perm": "string"
}
], - "ownerGroup": "string",
- "accessGroups": [
- "string"
], - "createdBy": "string",
- "updatedBy": "string",
- "datasetId": "string",
- "rawDatasetId": "string",
- "derivedDatasetId": "string",
- "createdAt": "2019-08-24T14:15:22Z",
- "updatedAt": "2019-08-24T14:15:22Z"
}| id required | string <JSON> Datablock id |
An object of model property name/value pairs
| id required | string Catalog internal UUIDv4 for datablock |
| archiveId required | string Unique identifier given bey archive system to the stored datablock. This id is used when data is retrieved back. |
| size required | number <double> Total size in bytes of all files in datablock when unpacked |
| packedSize | number <double> Size of datablock package file |
| chkAlg | string Algoritm used for calculation of checksums, e.g. sha2 |
| version required | string Version string defining format of how data is packed and stored in archive |
required | Array of objects (Datafile) |
| ownerGroup required | string Defines the group which owns the data, and therefore has unrestricted access to this data. Usually a pgroup like p12151 |
| accessGroups | Array of strings Optional additional groups which have read access to the data. Users which are member in one of the groups listed here are allowed to access this data. The special group 'public' makes data available to all users |
| createdBy | string Functional or user account name who created this instance |
| updatedBy | string Functional or user account name who last updated this instance |
| datasetId | string |
| rawDatasetId | string |
| derivedDatasetId | string |
| createdAt | string <date-time> |
| updatedAt | string <date-time> |
{- "id": "string",
- "archiveId": "string",
- "size": 0,
- "packedSize": 0,
- "chkAlg": "string",
- "version": "string",
- "dataFileList": [
- {
- "path": "string",
- "size": 0,
- "time": "2019-08-24T14:15:22Z",
- "chk": "string",
- "uid": "string",
- "gid": "string",
- "perm": "string"
}
], - "ownerGroup": "string",
- "accessGroups": [
- "string"
], - "createdBy": "string",
- "updatedBy": "string",
- "datasetId": "string",
- "rawDatasetId": "string",
- "derivedDatasetId": "string",
- "createdAt": "2019-08-24T14:15:22Z",
- "updatedAt": "2019-08-24T14:15:22Z"
}{- "id": "string",
- "archiveId": "string",
- "size": 0,
- "packedSize": 0,
- "chkAlg": "string",
- "version": "string",
- "dataFileList": [
- {
- "path": "string",
- "size": 0,
- "time": "2019-08-24T14:15:22Z",
- "chk": "string",
- "uid": "string",
- "gid": "string",
- "perm": "string"
}
], - "ownerGroup": "string",
- "accessGroups": [
- "string"
], - "createdBy": "string",
- "updatedBy": "string",
- "datasetId": "string",
- "rawDatasetId": "string",
- "derivedDatasetId": "string",
- "createdAt": "2019-08-24T14:15:22Z",
- "updatedAt": "2019-08-24T14:15:22Z"
}| id required | string <JSON> Model id |
Model instance data
| id required | string Catalog internal UUIDv4 for datablock |
| archiveId required | string Unique identifier given bey archive system to the stored datablock. This id is used when data is retrieved back. |
| size required | number <double> Total size in bytes of all files in datablock when unpacked |
| packedSize | number <double> Size of datablock package file |
| chkAlg | string Algoritm used for calculation of checksums, e.g. sha2 |
| version required | string Version string defining format of how data is packed and stored in archive |
required | Array of objects (Datafile) |
| ownerGroup required | string Defines the group which owns the data, and therefore has unrestricted access to this data. Usually a pgroup like p12151 |
| accessGroups | Array of strings Optional additional groups which have read access to the data. Users which are member in one of the groups listed here are allowed to access this data. The special group 'public' makes data available to all users |
| createdBy | string Functional or user account name who created this instance |
| updatedBy | string Functional or user account name who last updated this instance |
| datasetId | string |
| rawDatasetId | string |
| derivedDatasetId | string |
| createdAt | string <date-time> |
| updatedAt | string <date-time> |
{- "id": "string",
- "archiveId": "string",
- "size": 0,
- "packedSize": 0,
- "chkAlg": "string",
- "version": "string",
- "dataFileList": [
- {
- "path": "string",
- "size": 0,
- "time": "2019-08-24T14:15:22Z",
- "chk": "string",
- "uid": "string",
- "gid": "string",
- "perm": "string"
}
], - "ownerGroup": "string",
- "accessGroups": [
- "string"
], - "createdBy": "string",
- "updatedBy": "string",
- "datasetId": "string",
- "rawDatasetId": "string",
- "derivedDatasetId": "string",
- "createdAt": "2019-08-24T14:15:22Z",
- "updatedAt": "2019-08-24T14:15:22Z"
}{- "id": "string",
- "archiveId": "string",
- "size": 0,
- "packedSize": 0,
- "chkAlg": "string",
- "version": "string",
- "dataFileList": [
- {
- "path": "string",
- "size": 0,
- "time": "2019-08-24T14:15:22Z",
- "chk": "string",
- "uid": "string",
- "gid": "string",
- "perm": "string"
}
], - "ownerGroup": "string",
- "accessGroups": [
- "string"
], - "createdBy": "string",
- "updatedBy": "string",
- "datasetId": "string",
- "rawDatasetId": "string",
- "derivedDatasetId": "string",
- "createdAt": "2019-08-24T14:15:22Z",
- "updatedAt": "2019-08-24T14:15:22Z"
}| filter | string <JSON> Filter defining fields, where, include, order, offset, and limit - must be a JSON-encoded string ( |
{- "id": "string",
- "archiveId": "string",
- "size": 0,
- "packedSize": 0,
- "chkAlg": "string",
- "version": "string",
- "dataFileList": [
- {
- "path": "string",
- "size": 0,
- "time": "2019-08-24T14:15:22Z",
- "chk": "string",
- "uid": "string",
- "gid": "string",
- "perm": "string"
}
], - "ownerGroup": "string",
- "accessGroups": [
- "string"
], - "createdBy": "string",
- "updatedBy": "string",
- "datasetId": "string",
- "rawDatasetId": "string",
- "derivedDatasetId": "string",
- "createdAt": "2019-08-24T14:15:22Z",
- "updatedAt": "2019-08-24T14:15:22Z"
}| where | string <JSON> Criteria to match model instances |
An object of model property name/value pairs
| id required | string Catalog internal UUIDv4 for datablock |
| archiveId required | string Unique identifier given bey archive system to the stored datablock. This id is used when data is retrieved back. |
| size required | number <double> Total size in bytes of all files in datablock when unpacked |
| packedSize | number <double> Size of datablock package file |
| chkAlg | string Algoritm used for calculation of checksums, e.g. sha2 |
| version required | string Version string defining format of how data is packed and stored in archive |
required | Array of objects (Datafile) |
| ownerGroup required | string Defines the group which owns the data, and therefore has unrestricted access to this data. Usually a pgroup like p12151 |
| accessGroups | Array of strings Optional additional groups which have read access to the data. Users which are member in one of the groups listed here are allowed to access this data. The special group 'public' makes data available to all users |
| createdBy | string Functional or user account name who created this instance |
| updatedBy | string Functional or user account name who last updated this instance |
| datasetId | string |
| rawDatasetId | string |
| derivedDatasetId | string |
| createdAt | string <date-time> |
| updatedAt | string <date-time> |
{- "id": "string",
- "archiveId": "string",
- "size": 0,
- "packedSize": 0,
- "chkAlg": "string",
- "version": "string",
- "dataFileList": [
- {
- "path": "string",
- "size": 0,
- "time": "2019-08-24T14:15:22Z",
- "chk": "string",
- "uid": "string",
- "gid": "string",
- "perm": "string"
}
], - "ownerGroup": "string",
- "accessGroups": [
- "string"
], - "createdBy": "string",
- "updatedBy": "string",
- "datasetId": "string",
- "rawDatasetId": "string",
- "derivedDatasetId": "string",
- "createdAt": "2019-08-24T14:15:22Z",
- "updatedAt": "2019-08-24T14:15:22Z"
}{- "count": 0
}{ }{ }| id required | string <JSON> UserCredential id |
| refresh | boolean |
{- "realm": "string",
- "username": "string",
- "email": "string",
- "emailVerified": true,
- "id": "string"
}Model instance data
| provider | string |
| authScheme | string |
| externalId | string |
| profile | object |
| credentials | object |
| created | string <date-time> |
| modified | string <date-time> |
| id | string (ObjectID) ^[a-fA-F\d]{24}$ |
| userId | string (ObjectID) ^[a-fA-F\d]{24}$ |
{- "provider": "string",
- "authScheme": "string",
- "externalId": "string",
- "profile": { },
- "credentials": { },
- "created": "2019-08-24T14:15:22Z",
- "modified": "2019-08-24T14:15:22Z",
- "id": "string",
- "userId": "string"
}{- "provider": "string",
- "authScheme": "string",
- "externalId": "string",
- "profile": { },
- "credentials": { },
- "created": "2019-08-24T14:15:22Z",
- "modified": "2019-08-24T14:15:22Z",
- "id": "string",
- "userId": "string"
}Model instance data
| provider | string |
| authScheme | string |
| externalId | string |
| profile | object |
| credentials | object |
| created | string <date-time> |
| modified | string <date-time> |
| id | string (ObjectID) ^[a-fA-F\d]{24}$ |
| userId | string (ObjectID) ^[a-fA-F\d]{24}$ |
{- "provider": "string",
- "authScheme": "string",
- "externalId": "string",
- "profile": { },
- "credentials": { },
- "created": "2019-08-24T14:15:22Z",
- "modified": "2019-08-24T14:15:22Z",
- "id": "string",
- "userId": "string"
}{- "provider": "string",
- "authScheme": "string",
- "externalId": "string",
- "profile": { },
- "credentials": { },
- "created": "2019-08-24T14:15:22Z",
- "modified": "2019-08-24T14:15:22Z",
- "id": "string",
- "userId": "string"
}Model instance data
| provider | string |
| authScheme | string |
| externalId | string |
| profile | object |
| credentials | object |
| created | string <date-time> |
| modified | string <date-time> |
| id | string (ObjectID) ^[a-fA-F\d]{24}$ |
| userId | string (ObjectID) ^[a-fA-F\d]{24}$ |
{- "provider": "string",
- "authScheme": "string",
- "externalId": "string",
- "profile": { },
- "credentials": { },
- "created": "2019-08-24T14:15:22Z",
- "modified": "2019-08-24T14:15:22Z",
- "id": "string",
- "userId": "string"
}{- "provider": "string",
- "authScheme": "string",
- "externalId": "string",
- "profile": { },
- "credentials": { },
- "created": "2019-08-24T14:15:22Z",
- "modified": "2019-08-24T14:15:22Z",
- "id": "string",
- "userId": "string"
}| filter | string <JSON> Filter defining fields, where, include, order, offset, and limit - must be a JSON-encoded string ( |
[- {
- "provider": "string",
- "authScheme": "string",
- "externalId": "string",
- "profile": { },
- "credentials": { },
- "created": "2019-08-24T14:15:22Z",
- "modified": "2019-08-24T14:15:22Z",
- "id": "string",
- "userId": "string"
}
]Model instance data
| provider | string |
| authScheme | string |
| externalId | string |
| profile | object |
| credentials | object |
| created | string <date-time> |
| modified | string <date-time> |
| id | string (ObjectID) ^[a-fA-F\d]{24}$ |
| userId | string (ObjectID) ^[a-fA-F\d]{24}$ |
{- "provider": "string",
- "authScheme": "string",
- "externalId": "string",
- "profile": { },
- "credentials": { },
- "created": "2019-08-24T14:15:22Z",
- "modified": "2019-08-24T14:15:22Z",
- "id": "string",
- "userId": "string"
}{- "provider": "string",
- "authScheme": "string",
- "externalId": "string",
- "profile": { },
- "credentials": { },
- "created": "2019-08-24T14:15:22Z",
- "modified": "2019-08-24T14:15:22Z",
- "id": "string",
- "userId": "string"
}| where | string <JSON> Criteria to match model instances |
An object of model property name/value pairs
| provider | string |
| authScheme | string |
| externalId | string |
| profile | object |
| credentials | object |
| created | string <date-time> |
| modified | string <date-time> |
| id | string (ObjectID) ^[a-fA-F\d]{24}$ |
| userId | string (ObjectID) ^[a-fA-F\d]{24}$ |
{- "provider": "string",
- "authScheme": "string",
- "externalId": "string",
- "profile": { },
- "credentials": { },
- "created": "2019-08-24T14:15:22Z",
- "modified": "2019-08-24T14:15:22Z",
- "id": "string",
- "userId": "string"
}{- "provider": "string",
- "authScheme": "string",
- "externalId": "string",
- "profile": { },
- "credentials": { },
- "created": "2019-08-24T14:15:22Z",
- "modified": "2019-08-24T14:15:22Z",
- "id": "string",
- "userId": "string"
}| id required | string <JSON> Model id |
| filter | string <JSON> Filter defining fields and include - must be a JSON-encoded string ({"something":"value"}) |
{- "provider": "string",
- "authScheme": "string",
- "externalId": "string",
- "profile": { },
- "credentials": { },
- "created": "2019-08-24T14:15:22Z",
- "modified": "2019-08-24T14:15:22Z",
- "id": "string",
- "userId": "string"
}| id required | string <JSON> Model id |
Model instance data
| provider | string |
| authScheme | string |
| externalId | string |
| profile | object |
| credentials | object |
| created | string <date-time> |
| modified | string <date-time> |
| id | string (ObjectID) ^[a-fA-F\d]{24}$ |
| userId | string (ObjectID) ^[a-fA-F\d]{24}$ |
{- "provider": "string",
- "authScheme": "string",
- "externalId": "string",
- "profile": { },
- "credentials": { },
- "created": "2019-08-24T14:15:22Z",
- "modified": "2019-08-24T14:15:22Z",
- "id": "string",
- "userId": "string"
}{- "provider": "string",
- "authScheme": "string",
- "externalId": "string",
- "profile": { },
- "credentials": { },
- "created": "2019-08-24T14:15:22Z",
- "modified": "2019-08-24T14:15:22Z",
- "id": "string",
- "userId": "string"
}| id required | string <JSON> UserCredential id |
An object of model property name/value pairs
| provider | string |
| authScheme | string |
| externalId | string |
| profile | object |
| credentials | object |
| created | string <date-time> |
| modified | string <date-time> |
| id | string (ObjectID) ^[a-fA-F\d]{24}$ |
| userId | string (ObjectID) ^[a-fA-F\d]{24}$ |
{- "provider": "string",
- "authScheme": "string",
- "externalId": "string",
- "profile": { },
- "credentials": { },
- "created": "2019-08-24T14:15:22Z",
- "modified": "2019-08-24T14:15:22Z",
- "id": "string",
- "userId": "string"
}{- "provider": "string",
- "authScheme": "string",
- "externalId": "string",
- "profile": { },
- "credentials": { },
- "created": "2019-08-24T14:15:22Z",
- "modified": "2019-08-24T14:15:22Z",
- "id": "string",
- "userId": "string"
}| id required | string <JSON> Model id |
Model instance data
| provider | string |
| authScheme | string |
| externalId | string |
| profile | object |
| credentials | object |
| created | string <date-time> |
| modified | string <date-time> |
| id | string (ObjectID) ^[a-fA-F\d]{24}$ |
| userId | string (ObjectID) ^[a-fA-F\d]{24}$ |
{- "provider": "string",
- "authScheme": "string",
- "externalId": "string",
- "profile": { },
- "credentials": { },
- "created": "2019-08-24T14:15:22Z",
- "modified": "2019-08-24T14:15:22Z",
- "id": "string",
- "userId": "string"
}{- "provider": "string",
- "authScheme": "string",
- "externalId": "string",
- "profile": { },
- "credentials": { },
- "created": "2019-08-24T14:15:22Z",
- "modified": "2019-08-24T14:15:22Z",
- "id": "string",
- "userId": "string"
}| filter | string <JSON> Filter defining fields, where, include, order, offset, and limit - must be a JSON-encoded string ( |
{- "provider": "string",
- "authScheme": "string",
- "externalId": "string",
- "profile": { },
- "credentials": { },
- "created": "2019-08-24T14:15:22Z",
- "modified": "2019-08-24T14:15:22Z",
- "id": "string",
- "userId": "string"
}| where | string <JSON> Criteria to match model instances |
An object of model property name/value pairs
| provider | string |
| authScheme | string |
| externalId | string |
| profile | object |
| credentials | object |
| created | string <date-time> |
| modified | string <date-time> |
| id | string (ObjectID) ^[a-fA-F\d]{24}$ |
| userId | string (ObjectID) ^[a-fA-F\d]{24}$ |
{- "provider": "string",
- "authScheme": "string",
- "externalId": "string",
- "profile": { },
- "credentials": { },
- "created": "2019-08-24T14:15:22Z",
- "modified": "2019-08-24T14:15:22Z",
- "id": "string",
- "userId": "string"
}{- "count": 0
}| id required | string <JSON> UserIdentity id |
| refresh | boolean |
{- "realm": "string",
- "username": "string",
- "email": "string",
- "emailVerified": true,
- "id": "string"
}Model instance data
| id | number <double> |
| userId | string (ObjectID) ^[a-fA-F\d]{24}$ |
{- "id": 0,
- "userId": "string"
}{- "id": 0,
- "userId": "string"
}Model instance data
| id | number <double> |
| userId | string (ObjectID) ^[a-fA-F\d]{24}$ |
{- "id": 0,
- "userId": "string"
}{- "id": 0,
- "userId": "string"
}Model instance data
| id | number <double> |
| userId | string (ObjectID) ^[a-fA-F\d]{24}$ |
{- "id": 0,
- "userId": "string"
}{- "id": 0,
- "userId": "string"
}| filter | string <JSON> Filter defining fields, where, include, order, offset, and limit - must be a JSON-encoded string ( |
[- {
- "id": 0,
- "userId": "string"
}
]Model instance data
| id | number <double> |
| userId | string (ObjectID) ^[a-fA-F\d]{24}$ |
{- "id": 0,
- "userId": "string"
}{- "id": 0,
- "userId": "string"
}| where | string <JSON> Criteria to match model instances |
An object of model property name/value pairs
| id | number <double> |
| userId | string (ObjectID) ^[a-fA-F\d]{24}$ |
{- "id": 0,
- "userId": "string"
}{- "id": 0,
- "userId": "string"
}| id required | string <JSON> Model id |
| filter | string <JSON> Filter defining fields and include - must be a JSON-encoded string ({"something":"value"}) |
{- "id": 0,
- "userId": "string"
}| id required | string <JSON> Model id |
Model instance data
| id | number <double> |
| userId | string (ObjectID) ^[a-fA-F\d]{24}$ |
{- "id": 0,
- "userId": "string"
}{- "id": 0,
- "userId": "string"
}| id required | string <JSON> UserIdentity id |
An object of model property name/value pairs
| id | number <double> |
| userId | string (ObjectID) ^[a-fA-F\d]{24}$ |
{- "id": 0,
- "userId": "string"
}{- "id": 0,
- "userId": "string"
}| id required | string <JSON> Model id |
Model instance data
| id | number <double> |
| userId | string (ObjectID) ^[a-fA-F\d]{24}$ |
{- "id": 0,
- "userId": "string"
}{- "id": 0,
- "userId": "string"
}| filter | string <JSON> Filter defining fields, where, include, order, offset, and limit - must be a JSON-encoded string ( |
{- "id": 0,
- "userId": "string"
}| where | string <JSON> Criteria to match model instances |
An object of model property name/value pairs
| id | number <double> |
| userId | string (ObjectID) ^[a-fA-F\d]{24}$ |
{- "id": 0,
- "userId": "string"
}{- "count": 0
}Model instance data
| provider required | string |
| authScheme | string |
| credentials | object |
| created | string <date-time> |
| modified | string <date-time> |
| id | string (ObjectID) ^[a-fA-F\d]{24}$ |
{- "provider": "string",
- "authScheme": "string",
- "credentials": { },
- "created": "2019-08-24T14:15:22Z",
- "modified": "2019-08-24T14:15:22Z",
- "id": "string"
}{- "provider": "string",
- "authScheme": "string",
- "credentials": { },
- "created": "2019-08-24T14:15:22Z",
- "modified": "2019-08-24T14:15:22Z",
- "id": "string"
}Model instance data
| provider required | string |
| authScheme | string |
| credentials | object |
| created | string <date-time> |
| modified | string <date-time> |
| id | string (ObjectID) ^[a-fA-F\d]{24}$ |
{- "provider": "string",
- "authScheme": "string",
- "credentials": { },
- "created": "2019-08-24T14:15:22Z",
- "modified": "2019-08-24T14:15:22Z",
- "id": "string"
}{- "provider": "string",
- "authScheme": "string",
- "credentials": { },
- "created": "2019-08-24T14:15:22Z",
- "modified": "2019-08-24T14:15:22Z",
- "id": "string"
}Model instance data
| provider required | string |
| authScheme | string |
| credentials | object |
| created | string <date-time> |
| modified | string <date-time> |
| id | string (ObjectID) ^[a-fA-F\d]{24}$ |
{- "provider": "string",
- "authScheme": "string",
- "credentials": { },
- "created": "2019-08-24T14:15:22Z",
- "modified": "2019-08-24T14:15:22Z",
- "id": "string"
}{- "provider": "string",
- "authScheme": "string",
- "credentials": { },
- "created": "2019-08-24T14:15:22Z",
- "modified": "2019-08-24T14:15:22Z",
- "id": "string"
}| filter | string <JSON> Filter defining fields, where, include, order, offset, and limit - must be a JSON-encoded string ( |
[- {
- "provider": "string",
- "authScheme": "string",
- "credentials": { },
- "created": "2019-08-24T14:15:22Z",
- "modified": "2019-08-24T14:15:22Z",
- "id": "string"
}
]Model instance data
| provider required | string |
| authScheme | string |
| credentials | object |
| created | string <date-time> |
| modified | string <date-time> |
| id | string (ObjectID) ^[a-fA-F\d]{24}$ |
{- "provider": "string",
- "authScheme": "string",
- "credentials": { },
- "created": "2019-08-24T14:15:22Z",
- "modified": "2019-08-24T14:15:22Z",
- "id": "string"
}{- "provider": "string",
- "authScheme": "string",
- "credentials": { },
- "created": "2019-08-24T14:15:22Z",
- "modified": "2019-08-24T14:15:22Z",
- "id": "string"
}| where | string <JSON> Criteria to match model instances |
An object of model property name/value pairs
| provider required | string |
| authScheme | string |
| credentials | object |
| created | string <date-time> |
| modified | string <date-time> |
| id | string (ObjectID) ^[a-fA-F\d]{24}$ |
{- "provider": "string",
- "authScheme": "string",
- "credentials": { },
- "created": "2019-08-24T14:15:22Z",
- "modified": "2019-08-24T14:15:22Z",
- "id": "string"
}{- "provider": "string",
- "authScheme": "string",
- "credentials": { },
- "created": "2019-08-24T14:15:22Z",
- "modified": "2019-08-24T14:15:22Z",
- "id": "string"
}| id required | string <JSON> Model id |
| filter | string <JSON> Filter defining fields and include - must be a JSON-encoded string ({"something":"value"}) |
{- "provider": "string",
- "authScheme": "string",
- "credentials": { },
- "created": "2019-08-24T14:15:22Z",
- "modified": "2019-08-24T14:15:22Z",
- "id": "string"
}| id required | string <JSON> Model id |
Model instance data
| provider required | string |
| authScheme | string |
| credentials | object |
| created | string <date-time> |
| modified | string <date-time> |
| id | string (ObjectID) ^[a-fA-F\d]{24}$ |
{- "provider": "string",
- "authScheme": "string",
- "credentials": { },
- "created": "2019-08-24T14:15:22Z",
- "modified": "2019-08-24T14:15:22Z",
- "id": "string"
}{- "provider": "string",
- "authScheme": "string",
- "credentials": { },
- "created": "2019-08-24T14:15:22Z",
- "modified": "2019-08-24T14:15:22Z",
- "id": "string"
}| id required | string <JSON> ApplicationCredential id |
An object of model property name/value pairs
| provider required | string |
| authScheme | string |
| credentials | object |
| created | string <date-time> |
| modified | string <date-time> |
| id | string (ObjectID) ^[a-fA-F\d]{24}$ |
{- "provider": "string",
- "authScheme": "string",
- "credentials": { },
- "created": "2019-08-24T14:15:22Z",
- "modified": "2019-08-24T14:15:22Z",
- "id": "string"
}{- "provider": "string",
- "authScheme": "string",
- "credentials": { },
- "created": "2019-08-24T14:15:22Z",
- "modified": "2019-08-24T14:15:22Z",
- "id": "string"
}| id required | string <JSON> Model id |
Model instance data
| provider required | string |
| authScheme | string |
| credentials | object |
| created | string <date-time> |
| modified | string <date-time> |
| id | string (ObjectID) ^[a-fA-F\d]{24}$ |
{- "provider": "string",
- "authScheme": "string",
- "credentials": { },
- "created": "2019-08-24T14:15:22Z",
- "modified": "2019-08-24T14:15:22Z",
- "id": "string"
}{- "provider": "string",
- "authScheme": "string",
- "credentials": { },
- "created": "2019-08-24T14:15:22Z",
- "modified": "2019-08-24T14:15:22Z",
- "id": "string"
}| filter | string <JSON> Filter defining fields, where, include, order, offset, and limit - must be a JSON-encoded string ( |
{- "provider": "string",
- "authScheme": "string",
- "credentials": { },
- "created": "2019-08-24T14:15:22Z",
- "modified": "2019-08-24T14:15:22Z",
- "id": "string"
}| where | string <JSON> Criteria to match model instances |
An object of model property name/value pairs
| provider required | string |
| authScheme | string |
| credentials | object |
| created | string <date-time> |
| modified | string <date-time> |
| id | string (ObjectID) ^[a-fA-F\d]{24}$ |
{- "provider": "string",
- "authScheme": "string",
- "credentials": { },
- "created": "2019-08-24T14:15:22Z",
- "modified": "2019-08-24T14:15:22Z",
- "id": "string"
}{- "count": 0
}Model instance data
| manager | Array of strings Defines the emails of users that can modify the policy parameters |
| tapeRedundancy | string Default: "low" Defines the level of redundancy in storage to minimize loss of data. Allowed values are low, medium, high. Low could e.g. mean one tape copy only, medium could mean two tape copies and high two geo-redundant tape copies |
| autoArchive | boolean Default: true Flag to indicate that a dataset should be automatically archived after ingest. If false then archive delay is ignored |
| autoArchiveDelay | number <double> Default: 7 Number of days after dataset creation that (remaining) datasets are archived automatically |
| archiveEmailNotification | boolean Default: false Flag is true when an email notification should be sent to archiveEmailsToBeNotified upon an archive job creation |
| archiveEmailsToBeNotified | Array of strings Array of additional email addresses that should be notified up an archive job creation |
| retrieveEmailNotification | boolean Default: false Flag is true when an email notification should be sent to retrieveEmailsToBeNotified upon a retrieval job creation |
| retrieveEmailsToBeNotified | Array of strings Array of additional email addresses that should be notified up a retrieval job creation |
| embargoPeriod | number <double> Default: 3 Number of years after dataset creation before the dataset becomes public |
| ownerGroup required | string Defines the group which owns the data, and therefore has unrestricted access to this data. Usually a pgroup like p12151 |
| accessGroups | Array of strings Optional additional groups which have read access to the data. Users which are member in one of the groups listed here are allowed to access this data. The special group 'public' makes data available to all users |
| createdBy | string Functional or user account name who created this instance |
| updatedBy | string Functional or user account name who last updated this instance |
| id | string (ObjectID) ^[a-fA-F\d]{24}$ |
| createdAt | string <date-time> |
| updatedAt | string <date-time> |
{- "manager": [
- "string"
], - "tapeRedundancy": "low",
- "autoArchive": true,
- "autoArchiveDelay": 7,
- "archiveEmailNotification": false,
- "archiveEmailsToBeNotified": [
- "string"
], - "retrieveEmailNotification": false,
- "retrieveEmailsToBeNotified": [
- "string"
], - "embargoPeriod": 3,
- "ownerGroup": "string",
- "accessGroups": [
- "string"
], - "createdBy": "string",
- "updatedBy": "string",
- "id": "string",
- "createdAt": "2019-08-24T14:15:22Z",
- "updatedAt": "2019-08-24T14:15:22Z"
}{- "manager": [
- "string"
], - "tapeRedundancy": "low",
- "autoArchive": true,
- "autoArchiveDelay": 7,
- "archiveEmailNotification": false,
- "archiveEmailsToBeNotified": [
- "string"
], - "retrieveEmailNotification": false,
- "retrieveEmailsToBeNotified": [
- "string"
], - "embargoPeriod": 3,
- "ownerGroup": "string",
- "accessGroups": [
- "string"
], - "createdBy": "string",
- "updatedBy": "string",
- "id": "string",
- "createdAt": "2019-08-24T14:15:22Z",
- "updatedAt": "2019-08-24T14:15:22Z"
}Model instance data
| manager | Array of strings Defines the emails of users that can modify the policy parameters |
| tapeRedundancy | string Default: "low" Defines the level of redundancy in storage to minimize loss of data. Allowed values are low, medium, high. Low could e.g. mean one tape copy only, medium could mean two tape copies and high two geo-redundant tape copies |
| autoArchive | boolean Default: true Flag to indicate that a dataset should be automatically archived after ingest. If false then archive delay is ignored |
| autoArchiveDelay | number <double> Default: 7 Number of days after dataset creation that (remaining) datasets are archived automatically |
| archiveEmailNotification | boolean Default: false Flag is true when an email notification should be sent to archiveEmailsToBeNotified upon an archive job creation |
| archiveEmailsToBeNotified | Array of strings Array of additional email addresses that should be notified up an archive job creation |
| retrieveEmailNotification | boolean Default: false Flag is true when an email notification should be sent to retrieveEmailsToBeNotified upon a retrieval job creation |
| retrieveEmailsToBeNotified | Array of strings Array of additional email addresses that should be notified up a retrieval job creation |
| embargoPeriod | number <double> Default: 3 Number of years after dataset creation before the dataset becomes public |
| ownerGroup required | string Defines the group which owns the data, and therefore has unrestricted access to this data. Usually a pgroup like p12151 |
| accessGroups | Array of strings Optional additional groups which have read access to the data. Users which are member in one of the groups listed here are allowed to access this data. The special group 'public' makes data available to all users |
| createdBy | string Functional or user account name who created this instance |
| updatedBy | string Functional or user account name who last updated this instance |
| id | string (ObjectID) ^[a-fA-F\d]{24}$ |
| createdAt | string <date-time> |
| updatedAt | string <date-time> |
{- "manager": [
- "string"
], - "tapeRedundancy": "low",
- "autoArchive": true,
- "autoArchiveDelay": 7,
- "archiveEmailNotification": false,
- "archiveEmailsToBeNotified": [
- "string"
], - "retrieveEmailNotification": false,
- "retrieveEmailsToBeNotified": [
- "string"
], - "embargoPeriod": 3,
- "ownerGroup": "string",
- "accessGroups": [
- "string"
], - "createdBy": "string",
- "updatedBy": "string",
- "id": "string",
- "createdAt": "2019-08-24T14:15:22Z",
- "updatedAt": "2019-08-24T14:15:22Z"
}{- "manager": [
- "string"
], - "tapeRedundancy": "low",
- "autoArchive": true,
- "autoArchiveDelay": 7,
- "archiveEmailNotification": false,
- "archiveEmailsToBeNotified": [
- "string"
], - "retrieveEmailNotification": false,
- "retrieveEmailsToBeNotified": [
- "string"
], - "embargoPeriod": 3,
- "ownerGroup": "string",
- "accessGroups": [
- "string"
], - "createdBy": "string",
- "updatedBy": "string",
- "id": "string",
- "createdAt": "2019-08-24T14:15:22Z",
- "updatedAt": "2019-08-24T14:15:22Z"
}Model instance data
| manager | Array of strings Defines the emails of users that can modify the policy parameters |
| tapeRedundancy | string Default: "low" Defines the level of redundancy in storage to minimize loss of data. Allowed values are low, medium, high. Low could e.g. mean one tape copy only, medium could mean two tape copies and high two geo-redundant tape copies |
| autoArchive | boolean Default: true Flag to indicate that a dataset should be automatically archived after ingest. If false then archive delay is ignored |
| autoArchiveDelay | number <double> Default: 7 Number of days after dataset creation that (remaining) datasets are archived automatically |
| archiveEmailNotification | boolean Default: false Flag is true when an email notification should be sent to archiveEmailsToBeNotified upon an archive job creation |
| archiveEmailsToBeNotified | Array of strings Array of additional email addresses that should be notified up an archive job creation |
| retrieveEmailNotification | boolean Default: false Flag is true when an email notification should be sent to retrieveEmailsToBeNotified upon a retrieval job creation |
| retrieveEmailsToBeNotified | Array of strings Array of additional email addresses that should be notified up a retrieval job creation |
| embargoPeriod | number <double> Default: 3 Number of years after dataset creation before the dataset becomes public |
| ownerGroup required | string Defines the group which owns the data, and therefore has unrestricted access to this data. Usually a pgroup like p12151 |
| accessGroups | Array of strings Optional additional groups which have read access to the data. Users which are member in one of the groups listed here are allowed to access this data. The special group 'public' makes data available to all users |
| createdBy | string Functional or user account name who created this instance |
| updatedBy | string Functional or user account name who last updated this instance |
| id | string (ObjectID) ^[a-fA-F\d]{24}$ |
| createdAt | string <date-time> |
| updatedAt | string <date-time> |
{- "manager": [
- "string"
], - "tapeRedundancy": "low",
- "autoArchive": true,
- "autoArchiveDelay": 7,
- "archiveEmailNotification": false,
- "archiveEmailsToBeNotified": [
- "string"
], - "retrieveEmailNotification": false,
- "retrieveEmailsToBeNotified": [
- "string"
], - "embargoPeriod": 3,
- "ownerGroup": "string",
- "accessGroups": [
- "string"
], - "createdBy": "string",
- "updatedBy": "string",
- "id": "string",
- "createdAt": "2019-08-24T14:15:22Z",
- "updatedAt": "2019-08-24T14:15:22Z"
}{- "manager": [
- "string"
], - "tapeRedundancy": "low",
- "autoArchive": true,
- "autoArchiveDelay": 7,
- "archiveEmailNotification": false,
- "archiveEmailsToBeNotified": [
- "string"
], - "retrieveEmailNotification": false,
- "retrieveEmailsToBeNotified": [
- "string"
], - "embargoPeriod": 3,
- "ownerGroup": "string",
- "accessGroups": [
- "string"
], - "createdBy": "string",
- "updatedBy": "string",
- "id": "string",
- "createdAt": "2019-08-24T14:15:22Z",
- "updatedAt": "2019-08-24T14:15:22Z"
}| filter | string <JSON> Filter defining fields, where, include, order, offset, and limit - must be a JSON-encoded string ( |
[- {
- "manager": [
- "string"
], - "tapeRedundancy": "low",
- "autoArchive": true,
- "autoArchiveDelay": 7,
- "archiveEmailNotification": false,
- "archiveEmailsToBeNotified": [
- "string"
], - "retrieveEmailNotification": false,
- "retrieveEmailsToBeNotified": [
- "string"
], - "embargoPeriod": 3,
- "ownerGroup": "string",
- "accessGroups": [
- "string"
], - "createdBy": "string",
- "updatedBy": "string",
- "id": "string",
- "createdAt": "2019-08-24T14:15:22Z",
- "updatedAt": "2019-08-24T14:15:22Z"
}
]Model instance data
| manager | Array of strings Defines the emails of users that can modify the policy parameters |
| tapeRedundancy | string Default: "low" Defines the level of redundancy in storage to minimize loss of data. Allowed values are low, medium, high. Low could e.g. mean one tape copy only, medium could mean two tape copies and high two geo-redundant tape copies |
| autoArchive | boolean Default: true Flag to indicate that a dataset should be automatically archived after ingest. If false then archive delay is ignored |
| autoArchiveDelay | number <double> Default: 7 Number of days after dataset creation that (remaining) datasets are archived automatically |
| archiveEmailNotification | boolean Default: false Flag is true when an email notification should be sent to archiveEmailsToBeNotified upon an archive job creation |
| archiveEmailsToBeNotified | Array of strings Array of additional email addresses that should be notified up an archive job creation |
| retrieveEmailNotification | boolean Default: false Flag is true when an email notification should be sent to retrieveEmailsToBeNotified upon a retrieval job creation |
| retrieveEmailsToBeNotified | Array of strings Array of additional email addresses that should be notified up a retrieval job creation |
| embargoPeriod | number <double> Default: 3 Number of years after dataset creation before the dataset becomes public |
| ownerGroup required | string Defines the group which owns the data, and therefore has unrestricted access to this data. Usually a pgroup like p12151 |
| accessGroups | Array of strings Optional additional groups which have read access to the data. Users which are member in one of the groups listed here are allowed to access this data. The special group 'public' makes data available to all users |
| createdBy | string Functional or user account name who created this instance |
| updatedBy | string Functional or user account name who last updated this instance |
| id | string (ObjectID) ^[a-fA-F\d]{24}$ |
| createdAt | string <date-time> |
| updatedAt | string <date-time> |
{- "manager": [
- "string"
], - "tapeRedundancy": "low",
- "autoArchive": true,
- "autoArchiveDelay": 7,
- "archiveEmailNotification": false,
- "archiveEmailsToBeNotified": [
- "string"
], - "retrieveEmailNotification": false,
- "retrieveEmailsToBeNotified": [
- "string"
], - "embargoPeriod": 3,
- "ownerGroup": "string",
- "accessGroups": [
- "string"
], - "createdBy": "string",
- "updatedBy": "string",
- "id": "string",
- "createdAt": "2019-08-24T14:15:22Z",
- "updatedAt": "2019-08-24T14:15:22Z"
}{- "manager": [
- "string"
], - "tapeRedundancy": "low",
- "autoArchive": true,
- "autoArchiveDelay": 7,
- "archiveEmailNotification": false,
- "archiveEmailsToBeNotified": [
- "string"
], - "retrieveEmailNotification": false,
- "retrieveEmailsToBeNotified": [
- "string"
], - "embargoPeriod": 3,
- "ownerGroup": "string",
- "accessGroups": [
- "string"
], - "createdBy": "string",
- "updatedBy": "string",
- "id": "string",
- "createdAt": "2019-08-24T14:15:22Z",
- "updatedAt": "2019-08-24T14:15:22Z"
}| where | string <JSON> Criteria to match model instances |
An object of model property name/value pairs
| manager | Array of strings Defines the emails of users that can modify the policy parameters |
| tapeRedundancy | string Default: "low" Defines the level of redundancy in storage to minimize loss of data. Allowed values are low, medium, high. Low could e.g. mean one tape copy only, medium could mean two tape copies and high two geo-redundant tape copies |
| autoArchive | boolean Default: true Flag to indicate that a dataset should be automatically archived after ingest. If false then archive delay is ignored |
| autoArchiveDelay | number <double> Default: 7 Number of days after dataset creation that (remaining) datasets are archived automatically |
| archiveEmailNotification | boolean Default: false Flag is true when an email notification should be sent to archiveEmailsToBeNotified upon an archive job creation |
| archiveEmailsToBeNotified | Array of strings Array of additional email addresses that should be notified up an archive job creation |
| retrieveEmailNotification | boolean Default: false Flag is true when an email notification should be sent to retrieveEmailsToBeNotified upon a retrieval job creation |
| retrieveEmailsToBeNotified | Array of strings Array of additional email addresses that should be notified up a retrieval job creation |
| embargoPeriod | number <double> Default: 3 Number of years after dataset creation before the dataset becomes public |
| ownerGroup required | string Defines the group which owns the data, and therefore has unrestricted access to this data. Usually a pgroup like p12151 |
| accessGroups | Array of strings Optional additional groups which have read access to the data. Users which are member in one of the groups listed here are allowed to access this data. The special group 'public' makes data available to all users |
| createdBy | string Functional or user account name who created this instance |
| updatedBy | string Functional or user account name who last updated this instance |
| id | string (ObjectID) ^[a-fA-F\d]{24}$ |
| createdAt | string <date-time> |
| updatedAt | string <date-time> |
{- "manager": [
- "string"
], - "tapeRedundancy": "low",
- "autoArchive": true,
- "autoArchiveDelay": 7,
- "archiveEmailNotification": false,
- "archiveEmailsToBeNotified": [
- "string"
], - "retrieveEmailNotification": false,
- "retrieveEmailsToBeNotified": [
- "string"
], - "embargoPeriod": 3,
- "ownerGroup": "string",
- "accessGroups": [
- "string"
], - "createdBy": "string",
- "updatedBy": "string",
- "id": "string",
- "createdAt": "2019-08-24T14:15:22Z",
- "updatedAt": "2019-08-24T14:15:22Z"
}{- "manager": [
- "string"
], - "tapeRedundancy": "low",
- "autoArchive": true,
- "autoArchiveDelay": 7,
- "archiveEmailNotification": false,
- "archiveEmailsToBeNotified": [
- "string"
], - "retrieveEmailNotification": false,
- "retrieveEmailsToBeNotified": [
- "string"
], - "embargoPeriod": 3,
- "ownerGroup": "string",
- "accessGroups": [
- "string"
], - "createdBy": "string",
- "updatedBy": "string",
- "id": "string",
- "createdAt": "2019-08-24T14:15:22Z",
- "updatedAt": "2019-08-24T14:15:22Z"
}| id required | string <JSON> Model id |
| filter | string <JSON> Filter defining fields and include - must be a JSON-encoded string ({"something":"value"}) |
{- "manager": [
- "string"
], - "tapeRedundancy": "low",
- "autoArchive": true,
- "autoArchiveDelay": 7,
- "archiveEmailNotification": false,
- "archiveEmailsToBeNotified": [
- "string"
], - "retrieveEmailNotification": false,
- "retrieveEmailsToBeNotified": [
- "string"
], - "embargoPeriod": 3,
- "ownerGroup": "string",
- "accessGroups": [
- "string"
], - "createdBy": "string",
- "updatedBy": "string",
- "id": "string",
- "createdAt": "2019-08-24T14:15:22Z",
- "updatedAt": "2019-08-24T14:15:22Z"
}| id required | string <JSON> Model id |
Model instance data
| manager | Array of strings Defines the emails of users that can modify the policy parameters |
| tapeRedundancy | string Default: "low" Defines the level of redundancy in storage to minimize loss of data. Allowed values are low, medium, high. Low could e.g. mean one tape copy only, medium could mean two tape copies and high two geo-redundant tape copies |
| autoArchive | boolean Default: true Flag to indicate that a dataset should be automatically archived after ingest. If false then archive delay is ignored |
| autoArchiveDelay | number <double> Default: 7 Number of days after dataset creation that (remaining) datasets are archived automatically |
| archiveEmailNotification | boolean Default: false Flag is true when an email notification should be sent to archiveEmailsToBeNotified upon an archive job creation |
| archiveEmailsToBeNotified | Array of strings Array of additional email addresses that should be notified up an archive job creation |
| retrieveEmailNotification | boolean Default: false Flag is true when an email notification should be sent to retrieveEmailsToBeNotified upon a retrieval job creation |
| retrieveEmailsToBeNotified | Array of strings Array of additional email addresses that should be notified up a retrieval job creation |
| embargoPeriod | number <double> Default: 3 Number of years after dataset creation before the dataset becomes public |
| ownerGroup required | string Defines the group which owns the data, and therefore has unrestricted access to this data. Usually a pgroup like p12151 |
| accessGroups | Array of strings Optional additional groups which have read access to the data. Users which are member in one of the groups listed here are allowed to access this data. The special group 'public' makes data available to all users |
| createdBy | string Functional or user account name who created this instance |
| updatedBy | string Functional or user account name who last updated this instance |
| id | string (ObjectID) ^[a-fA-F\d]{24}$ |
| createdAt | string <date-time> |
| updatedAt | string <date-time> |
{- "manager": [
- "string"
], - "tapeRedundancy": "low",
- "autoArchive": true,
- "autoArchiveDelay": 7,
- "archiveEmailNotification": false,
- "archiveEmailsToBeNotified": [
- "string"
], - "retrieveEmailNotification": false,
- "retrieveEmailsToBeNotified": [
- "string"
], - "embargoPeriod": 3,
- "ownerGroup": "string",
- "accessGroups": [
- "string"
], - "createdBy": "string",
- "updatedBy": "string",
- "id": "string",
- "createdAt": "2019-08-24T14:15:22Z",
- "updatedAt": "2019-08-24T14:15:22Z"
}{- "manager": [
- "string"
], - "tapeRedundancy": "low",
- "autoArchive": true,
- "autoArchiveDelay": 7,
- "archiveEmailNotification": false,
- "archiveEmailsToBeNotified": [
- "string"
], - "retrieveEmailNotification": false,
- "retrieveEmailsToBeNotified": [
- "string"
], - "embargoPeriod": 3,
- "ownerGroup": "string",
- "accessGroups": [
- "string"
], - "createdBy": "string",
- "updatedBy": "string",
- "id": "string",
- "createdAt": "2019-08-24T14:15:22Z",
- "updatedAt": "2019-08-24T14:15:22Z"
}| id required | string <JSON> Policy id |
An object of model property name/value pairs
| manager | Array of strings Defines the emails of users that can modify the policy parameters |
| tapeRedundancy | string Default: "low" Defines the level of redundancy in storage to minimize loss of data. Allowed values are low, medium, high. Low could e.g. mean one tape copy only, medium could mean two tape copies and high two geo-redundant tape copies |
| autoArchive | boolean Default: true Flag to indicate that a dataset should be automatically archived after ingest. If false then archive delay is ignored |
| autoArchiveDelay | number <double> Default: 7 Number of days after dataset creation that (remaining) datasets are archived automatically |
| archiveEmailNotification | boolean Default: false Flag is true when an email notification should be sent to archiveEmailsToBeNotified upon an archive job creation |
| archiveEmailsToBeNotified | Array of strings Array of additional email addresses that should be notified up an archive job creation |
| retrieveEmailNotification | boolean Default: false Flag is true when an email notification should be sent to retrieveEmailsToBeNotified upon a retrieval job creation |
| retrieveEmailsToBeNotified | Array of strings Array of additional email addresses that should be notified up a retrieval job creation |
| embargoPeriod | number <double> Default: 3 Number of years after dataset creation before the dataset becomes public |
| ownerGroup required | string Defines the group which owns the data, and therefore has unrestricted access to this data. Usually a pgroup like p12151 |
| accessGroups | Array of strings Optional additional groups which have read access to the data. Users which are member in one of the groups listed here are allowed to access this data. The special group 'public' makes data available to all users |
| createdBy | string Functional or user account name who created this instance |
| updatedBy | string Functional or user account name who last updated this instance |
| id | string (ObjectID) ^[a-fA-F\d]{24}$ |
| createdAt | string <date-time> |
| updatedAt | string <date-time> |
{- "manager": [
- "string"
], - "tapeRedundancy": "low",
- "autoArchive": true,
- "autoArchiveDelay": 7,
- "archiveEmailNotification": false,
- "archiveEmailsToBeNotified": [
- "string"
], - "retrieveEmailNotification": false,
- "retrieveEmailsToBeNotified": [
- "string"
], - "embargoPeriod": 3,
- "ownerGroup": "string",
- "accessGroups": [
- "string"
], - "createdBy": "string",
- "updatedBy": "string",
- "id": "string",
- "createdAt": "2019-08-24T14:15:22Z",
- "updatedAt": "2019-08-24T14:15:22Z"
}{- "manager": [
- "string"
], - "tapeRedundancy": "low",
- "autoArchive": true,
- "autoArchiveDelay": 7,
- "archiveEmailNotification": false,
- "archiveEmailsToBeNotified": [
- "string"
], - "retrieveEmailNotification": false,
- "retrieveEmailsToBeNotified": [
- "string"
], - "embargoPeriod": 3,
- "ownerGroup": "string",
- "accessGroups": [
- "string"
], - "createdBy": "string",
- "updatedBy": "string",
- "id": "string",
- "createdAt": "2019-08-24T14:15:22Z",
- "updatedAt": "2019-08-24T14:15:22Z"
}| id required | string <JSON> Model id |
Model instance data
| manager | Array of strings Defines the emails of users that can modify the policy parameters |
| tapeRedundancy | string Default: "low" Defines the level of redundancy in storage to minimize loss of data. Allowed values are low, medium, high. Low could e.g. mean one tape copy only, medium could mean two tape copies and high two geo-redundant tape copies |
| autoArchive | boolean Default: true Flag to indicate that a dataset should be automatically archived after ingest. If false then archive delay is ignored |
| autoArchiveDelay | number <double> Default: 7 Number of days after dataset creation that (remaining) datasets are archived automatically |
| archiveEmailNotification | boolean Default: false Flag is true when an email notification should be sent to archiveEmailsToBeNotified upon an archive job creation |
| archiveEmailsToBeNotified | Array of strings Array of additional email addresses that should be notified up an archive job creation |
| retrieveEmailNotification | boolean Default: false Flag is true when an email notification should be sent to retrieveEmailsToBeNotified upon a retrieval job creation |
| retrieveEmailsToBeNotified | Array of strings Array of additional email addresses that should be notified up a retrieval job creation |
| embargoPeriod | number <double> Default: 3 Number of years after dataset creation before the dataset becomes public |
| ownerGroup required | string Defines the group which owns the data, and therefore has unrestricted access to this data. Usually a pgroup like p12151 |
| accessGroups | Array of strings Optional additional groups which have read access to the data. Users which are member in one of the groups listed here are allowed to access this data. The special group 'public' makes data available to all users |
| createdBy | string Functional or user account name who created this instance |
| updatedBy | string Functional or user account name who last updated this instance |
| id | string (ObjectID) ^[a-fA-F\d]{24}$ |
| createdAt | string <date-time> |
| updatedAt | string <date-time> |
{- "manager": [
- "string"
], - "tapeRedundancy": "low",
- "autoArchive": true,
- "autoArchiveDelay": 7,
- "archiveEmailNotification": false,
- "archiveEmailsToBeNotified": [
- "string"
], - "retrieveEmailNotification": false,
- "retrieveEmailsToBeNotified": [
- "string"
], - "embargoPeriod": 3,
- "ownerGroup": "string",
- "accessGroups": [
- "string"
], - "createdBy": "string",
- "updatedBy": "string",
- "id": "string",
- "createdAt": "2019-08-24T14:15:22Z",
- "updatedAt": "2019-08-24T14:15:22Z"
}{- "manager": [
- "string"
], - "tapeRedundancy": "low",
- "autoArchive": true,
- "autoArchiveDelay": 7,
- "archiveEmailNotification": false,
- "archiveEmailsToBeNotified": [
- "string"
], - "retrieveEmailNotification": false,
- "retrieveEmailsToBeNotified": [
- "string"
], - "embargoPeriod": 3,
- "ownerGroup": "string",
- "accessGroups": [
- "string"
], - "createdBy": "string",
- "updatedBy": "string",
- "id": "string",
- "createdAt": "2019-08-24T14:15:22Z",
- "updatedAt": "2019-08-24T14:15:22Z"
}| filter | string <JSON> Filter defining fields, where, include, order, offset, and limit - must be a JSON-encoded string ( |
{- "manager": [
- "string"
], - "tapeRedundancy": "low",
- "autoArchive": true,
- "autoArchiveDelay": 7,
- "archiveEmailNotification": false,
- "archiveEmailsToBeNotified": [
- "string"
], - "retrieveEmailNotification": false,
- "retrieveEmailsToBeNotified": [
- "string"
], - "embargoPeriod": 3,
- "ownerGroup": "string",
- "accessGroups": [
- "string"
], - "createdBy": "string",
- "updatedBy": "string",
- "id": "string",
- "createdAt": "2019-08-24T14:15:22Z",
- "updatedAt": "2019-08-24T14:15:22Z"
}| where | string <JSON> Criteria to match model instances |
An object of model property name/value pairs
| manager | Array of strings Defines the emails of users that can modify the policy parameters |
| tapeRedundancy | string Default: "low" Defines the level of redundancy in storage to minimize loss of data. Allowed values are low, medium, high. Low could e.g. mean one tape copy only, medium could mean two tape copies and high two geo-redundant tape copies |
| autoArchive | boolean Default: true Flag to indicate that a dataset should be automatically archived after ingest. If false then archive delay is ignored |
| autoArchiveDelay | number <double> Default: 7 Number of days after dataset creation that (remaining) datasets are archived automatically |
| archiveEmailNotification | boolean Default: false Flag is true when an email notification should be sent to archiveEmailsToBeNotified upon an archive job creation |
| archiveEmailsToBeNotified | Array of strings Array of additional email addresses that should be notified up an archive job creation |
| retrieveEmailNotification | boolean Default: false Flag is true when an email notification should be sent to retrieveEmailsToBeNotified upon a retrieval job creation |
| retrieveEmailsToBeNotified | Array of strings Array of additional email addresses that should be notified up a retrieval job creation |
| embargoPeriod | number <double> Default: 3 Number of years after dataset creation before the dataset becomes public |
| ownerGroup required | string Defines the group which owns the data, and therefore has unrestricted access to this data. Usually a pgroup like p12151 |
| accessGroups | Array of strings Optional additional groups which have read access to the data. Users which are member in one of the groups listed here are allowed to access this data. The special group 'public' makes data available to all users |
| createdBy | string Functional or user account name who created this instance |
| updatedBy | string Functional or user account name who last updated this instance |
| id | string (ObjectID) ^[a-fA-F\d]{24}$ |
| createdAt | string <date-time> |
| updatedAt | string <date-time> |
{- "manager": [
- "string"
], - "tapeRedundancy": "low",
- "autoArchive": true,
- "autoArchiveDelay": 7,
- "archiveEmailNotification": false,
- "archiveEmailsToBeNotified": [
- "string"
], - "retrieveEmailNotification": false,
- "retrieveEmailsToBeNotified": [
- "string"
], - "embargoPeriod": 3,
- "ownerGroup": "string",
- "accessGroups": [
- "string"
], - "createdBy": "string",
- "updatedBy": "string",
- "id": "string",
- "createdAt": "2019-08-24T14:15:22Z",
- "updatedAt": "2019-08-24T14:15:22Z"
}{- "count": 0
}{ }{ }| ownerGroupList required | string Comma-separated string of owner groups to update e.g. "p14159, p24959" |
| data required | string <JSON> |
{ }This collection keeps information about jobs to be excuted in external systems. In particular it keeps information about the jobs submitted for archiving or retrieving datasets stored inside an archive system. It can also be used to keep track of analysis jobs e.g. for automated analysis workflows.
Model instance data
| emailJobInitiator required | string The email of the person initiating the job request |
| type required | string Default: "retrieve" Type of job, e.g. archive, retrieve etc |
| creationTime | string <date-time> Time when job is created. Format according to chapter 5.6 internet date/time format in RFC 3339 |
| executionTime | string <date-time> Time when job should be executed. If not specified then the Job will be executed asap. Format according to chapter 5.6 internet date/time format in RFC 3339 |
| jobParams | object Object of key-value pairs defining job input parameters, e.g. 'desinationPath' for retrieve jobs or 'tapeCopies' for archive jobs |
| jobStatusMessage | string Defines current status of job lifecycle |
| datasetList required | object Array of objects with keys: pid, files. The value for the pid key defines the dataset ID, the value for the files key is an array of file names. This array is either an empty array, implying that all files within the dataset are selected or an explicit list of dataset-relative file paths, which should be selected |
| jobResultObject | object Detailed return value after job is finished |
| id | string (ObjectID) ^[a-fA-F\d]{24}$ |
| createdAt | string <date-time> |
| updatedAt | string <date-time> |
{- "emailJobInitiator": "string",
- "type": "retrieve",
- "creationTime": "2019-08-24T14:15:22Z",
- "executionTime": "2019-08-24T14:15:22Z",
- "jobParams": { },
- "jobStatusMessage": "string",
- "datasetList": { },
- "jobResultObject": { },
- "id": "string",
- "createdAt": "2019-08-24T14:15:22Z",
- "updatedAt": "2019-08-24T14:15:22Z"
}{- "emailJobInitiator": "string",
- "type": "retrieve",
- "creationTime": "2019-08-24T14:15:22Z",
- "executionTime": "2019-08-24T14:15:22Z",
- "jobParams": { },
- "jobStatusMessage": "string",
- "datasetList": { },
- "jobResultObject": { },
- "id": "string",
- "createdAt": "2019-08-24T14:15:22Z",
- "updatedAt": "2019-08-24T14:15:22Z"
}Model instance data
| emailJobInitiator required | string The email of the person initiating the job request |
| type required | string Default: "retrieve" Type of job, e.g. archive, retrieve etc |
| creationTime | string <date-time> Time when job is created. Format according to chapter 5.6 internet date/time format in RFC 3339 |
| executionTime | string <date-time> Time when job should be executed. If not specified then the Job will be executed asap. Format according to chapter 5.6 internet date/time format in RFC 3339 |
| jobParams | object Object of key-value pairs defining job input parameters, e.g. 'desinationPath' for retrieve jobs or 'tapeCopies' for archive jobs |
| jobStatusMessage | string Defines current status of job lifecycle |
| datasetList required | object Array of objects with keys: pid, files. The value for the pid key defines the dataset ID, the value for the files key is an array of file names. This array is either an empty array, implying that all files within the dataset are selected or an explicit list of dataset-relative file paths, which should be selected |
| jobResultObject | object Detailed return value after job is finished |
| id | string (ObjectID) ^[a-fA-F\d]{24}$ |
| createdAt | string <date-time> |
| updatedAt | string <date-time> |
{- "emailJobInitiator": "string",
- "type": "retrieve",
- "creationTime": "2019-08-24T14:15:22Z",
- "executionTime": "2019-08-24T14:15:22Z",
- "jobParams": { },
- "jobStatusMessage": "string",
- "datasetList": { },
- "jobResultObject": { },
- "id": "string",
- "createdAt": "2019-08-24T14:15:22Z",
- "updatedAt": "2019-08-24T14:15:22Z"
}{- "emailJobInitiator": "string",
- "type": "retrieve",
- "creationTime": "2019-08-24T14:15:22Z",
- "executionTime": "2019-08-24T14:15:22Z",
- "jobParams": { },
- "jobStatusMessage": "string",
- "datasetList": { },
- "jobResultObject": { },
- "id": "string",
- "createdAt": "2019-08-24T14:15:22Z",
- "updatedAt": "2019-08-24T14:15:22Z"
}Model instance data
| emailJobInitiator required | string The email of the person initiating the job request |
| type required | string Default: "retrieve" Type of job, e.g. archive, retrieve etc |
| creationTime | string <date-time> Time when job is created. Format according to chapter 5.6 internet date/time format in RFC 3339 |
| executionTime | string <date-time> Time when job should be executed. If not specified then the Job will be executed asap. Format according to chapter 5.6 internet date/time format in RFC 3339 |
| jobParams | object Object of key-value pairs defining job input parameters, e.g. 'desinationPath' for retrieve jobs or 'tapeCopies' for archive jobs |
| jobStatusMessage | string Defines current status of job lifecycle |
| datasetList required | object Array of objects with keys: pid, files. The value for the pid key defines the dataset ID, the value for the files key is an array of file names. This array is either an empty array, implying that all files within the dataset are selected or an explicit list of dataset-relative file paths, which should be selected |
| jobResultObject | object Detailed return value after job is finished |
| id | string (ObjectID) ^[a-fA-F\d]{24}$ |
| createdAt | string <date-time> |
| updatedAt | string <date-time> |
{- "emailJobInitiator": "string",
- "type": "retrieve",
- "creationTime": "2019-08-24T14:15:22Z",
- "executionTime": "2019-08-24T14:15:22Z",
- "jobParams": { },
- "jobStatusMessage": "string",
- "datasetList": { },
- "jobResultObject": { },
- "id": "string",
- "createdAt": "2019-08-24T14:15:22Z",
- "updatedAt": "2019-08-24T14:15:22Z"
}{- "emailJobInitiator": "string",
- "type": "retrieve",
- "creationTime": "2019-08-24T14:15:22Z",
- "executionTime": "2019-08-24T14:15:22Z",
- "jobParams": { },
- "jobStatusMessage": "string",
- "datasetList": { },
- "jobResultObject": { },
- "id": "string",
- "createdAt": "2019-08-24T14:15:22Z",
- "updatedAt": "2019-08-24T14:15:22Z"
}| filter | string <JSON> Filter defining fields, where, include, order, offset, and limit - must be a JSON-encoded string ( |
[- {
- "emailJobInitiator": "string",
- "type": "retrieve",
- "creationTime": "2019-08-24T14:15:22Z",
- "executionTime": "2019-08-24T14:15:22Z",
- "jobParams": { },
- "jobStatusMessage": "string",
- "datasetList": { },
- "jobResultObject": { },
- "id": "string",
- "createdAt": "2019-08-24T14:15:22Z",
- "updatedAt": "2019-08-24T14:15:22Z"
}
]Model instance data
| emailJobInitiator required | string The email of the person initiating the job request |
| type required | string Default: "retrieve" Type of job, e.g. archive, retrieve etc |
| creationTime | string <date-time> Time when job is created. Format according to chapter 5.6 internet date/time format in RFC 3339 |
| executionTime | string <date-time> Time when job should be executed. If not specified then the Job will be executed asap. Format according to chapter 5.6 internet date/time format in RFC 3339 |
| jobParams | object Object of key-value pairs defining job input parameters, e.g. 'desinationPath' for retrieve jobs or 'tapeCopies' for archive jobs |
| jobStatusMessage | string Defines current status of job lifecycle |
| datasetList required | object Array of objects with keys: pid, files. The value for the pid key defines the dataset ID, the value for the files key is an array of file names. This array is either an empty array, implying that all files within the dataset are selected or an explicit list of dataset-relative file paths, which should be selected |
| jobResultObject | object Detailed return value after job is finished |
| id | string (ObjectID) ^[a-fA-F\d]{24}$ |
| createdAt | string <date-time> |
| updatedAt | string <date-time> |
{- "emailJobInitiator": "string",
- "type": "retrieve",
- "creationTime": "2019-08-24T14:15:22Z",
- "executionTime": "2019-08-24T14:15:22Z",
- "jobParams": { },
- "jobStatusMessage": "string",
- "datasetList": { },
- "jobResultObject": { },
- "id": "string",
- "createdAt": "2019-08-24T14:15:22Z",
- "updatedAt": "2019-08-24T14:15:22Z"
}{- "emailJobInitiator": "string",
- "type": "retrieve",
- "creationTime": "2019-08-24T14:15:22Z",
- "executionTime": "2019-08-24T14:15:22Z",
- "jobParams": { },
- "jobStatusMessage": "string",
- "datasetList": { },
- "jobResultObject": { },
- "id": "string",
- "createdAt": "2019-08-24T14:15:22Z",
- "updatedAt": "2019-08-24T14:15:22Z"
}| where | string <JSON> Criteria to match model instances |
An object of model property name/value pairs
| emailJobInitiator required | string The email of the person initiating the job request |
| type required | string Default: "retrieve" Type of job, e.g. archive, retrieve etc |
| creationTime | string <date-time> Time when job is created. Format according to chapter 5.6 internet date/time format in RFC 3339 |
| executionTime | string <date-time> Time when job should be executed. If not specified then the Job will be executed asap. Format according to chapter 5.6 internet date/time format in RFC 3339 |
| jobParams | object Object of key-value pairs defining job input parameters, e.g. 'desinationPath' for retrieve jobs or 'tapeCopies' for archive jobs |
| jobStatusMessage | string Defines current status of job lifecycle |
| datasetList required | object Array of objects with keys: pid, files. The value for the pid key defines the dataset ID, the value for the files key is an array of file names. This array is either an empty array, implying that all files within the dataset are selected or an explicit list of dataset-relative file paths, which should be selected |
| jobResultObject | object Detailed return value after job is finished |
| id | string (ObjectID) ^[a-fA-F\d]{24}$ |
| createdAt | string <date-time> |
| updatedAt | string <date-time> |
{- "emailJobInitiator": "string",
- "type": "retrieve",
- "creationTime": "2019-08-24T14:15:22Z",
- "executionTime": "2019-08-24T14:15:22Z",
- "jobParams": { },
- "jobStatusMessage": "string",
- "datasetList": { },
- "jobResultObject": { },
- "id": "string",
- "createdAt": "2019-08-24T14:15:22Z",
- "updatedAt": "2019-08-24T14:15:22Z"
}{- "emailJobInitiator": "string",
- "type": "retrieve",
- "creationTime": "2019-08-24T14:15:22Z",
- "executionTime": "2019-08-24T14:15:22Z",
- "jobParams": { },
- "jobStatusMessage": "string",
- "datasetList": { },
- "jobResultObject": { },
- "id": "string",
- "createdAt": "2019-08-24T14:15:22Z",
- "updatedAt": "2019-08-24T14:15:22Z"
}| id required | string <JSON> Model id |
| filter | string <JSON> Filter defining fields and include - must be a JSON-encoded string ({"something":"value"}) |
{- "emailJobInitiator": "string",
- "type": "retrieve",
- "creationTime": "2019-08-24T14:15:22Z",
- "executionTime": "2019-08-24T14:15:22Z",
- "jobParams": { },
- "jobStatusMessage": "string",
- "datasetList": { },
- "jobResultObject": { },
- "id": "string",
- "createdAt": "2019-08-24T14:15:22Z",
- "updatedAt": "2019-08-24T14:15:22Z"
}| id required | string <JSON> Job id |
An object of model property name/value pairs
| emailJobInitiator required | string The email of the person initiating the job request |
| type required | string Default: "retrieve" Type of job, e.g. archive, retrieve etc |
| creationTime | string <date-time> Time when job is created. Format according to chapter 5.6 internet date/time format in RFC 3339 |
| executionTime | string <date-time> Time when job should be executed. If not specified then the Job will be executed asap. Format according to chapter 5.6 internet date/time format in RFC 3339 |
| jobParams | object Object of key-value pairs defining job input parameters, e.g. 'desinationPath' for retrieve jobs or 'tapeCopies' for archive jobs |
| jobStatusMessage | string Defines current status of job lifecycle |
| datasetList required | object Array of objects with keys: pid, files. The value for the pid key defines the dataset ID, the value for the files key is an array of file names. This array is either an empty array, implying that all files within the dataset are selected or an explicit list of dataset-relative file paths, which should be selected |
| jobResultObject | object Detailed return value after job is finished |
| id | string (ObjectID) ^[a-fA-F\d]{24}$ |
| createdAt | string <date-time> |
| updatedAt | string <date-time> |
{- "emailJobInitiator": "string",
- "type": "retrieve",
- "creationTime": "2019-08-24T14:15:22Z",
- "executionTime": "2019-08-24T14:15:22Z",
- "jobParams": { },
- "jobStatusMessage": "string",
- "datasetList": { },
- "jobResultObject": { },
- "id": "string",
- "createdAt": "2019-08-24T14:15:22Z",
- "updatedAt": "2019-08-24T14:15:22Z"
}{- "emailJobInitiator": "string",
- "type": "retrieve",
- "creationTime": "2019-08-24T14:15:22Z",
- "executionTime": "2019-08-24T14:15:22Z",
- "jobParams": { },
- "jobStatusMessage": "string",
- "datasetList": { },
- "jobResultObject": { },
- "id": "string",
- "createdAt": "2019-08-24T14:15:22Z",
- "updatedAt": "2019-08-24T14:15:22Z"
}| id required | string <JSON> Job id |
An object of model property name/value pairs
| emailJobInitiator required | string The email of the person initiating the job request |
| type required | string Default: "retrieve" Type of job, e.g. archive, retrieve etc |
| creationTime | string <date-time> Time when job is created. Format according to chapter 5.6 internet date/time format in RFC 3339 |
| executionTime | string <date-time> Time when job should be executed. If not specified then the Job will be executed asap. Format according to chapter 5.6 internet date/time format in RFC 3339 |
| jobParams | object Object of key-value pairs defining job input parameters, e.g. 'desinationPath' for retrieve jobs or 'tapeCopies' for archive jobs |
| jobStatusMessage | string Defines current status of job lifecycle |
| datasetList required | object Array of objects with keys: pid, files. The value for the pid key defines the dataset ID, the value for the files key is an array of file names. This array is either an empty array, implying that all files within the dataset are selected or an explicit list of dataset-relative file paths, which should be selected |
| jobResultObject | object Detailed return value after job is finished |
| id | string (ObjectID) ^[a-fA-F\d]{24}$ |
| createdAt | string <date-time> |
| updatedAt | string <date-time> |
{- "emailJobInitiator": "string",
- "type": "retrieve",
- "creationTime": "2019-08-24T14:15:22Z",
- "executionTime": "2019-08-24T14:15:22Z",
- "jobParams": { },
- "jobStatusMessage": "string",
- "datasetList": { },
- "jobResultObject": { },
- "id": "string",
- "createdAt": "2019-08-24T14:15:22Z",
- "updatedAt": "2019-08-24T14:15:22Z"
}{- "emailJobInitiator": "string",
- "type": "retrieve",
- "creationTime": "2019-08-24T14:15:22Z",
- "executionTime": "2019-08-24T14:15:22Z",
- "jobParams": { },
- "jobStatusMessage": "string",
- "datasetList": { },
- "jobResultObject": { },
- "id": "string",
- "createdAt": "2019-08-24T14:15:22Z",
- "updatedAt": "2019-08-24T14:15:22Z"
}| id required | string <JSON> Model id |
Model instance data
| emailJobInitiator required | string The email of the person initiating the job request |
| type required | string Default: "retrieve" Type of job, e.g. archive, retrieve etc |
| creationTime | string <date-time> Time when job is created. Format according to chapter 5.6 internet date/time format in RFC 3339 |
| executionTime | string <date-time> Time when job should be executed. If not specified then the Job will be executed asap. Format according to chapter 5.6 internet date/time format in RFC 3339 |
| jobParams | object Object of key-value pairs defining job input parameters, e.g. 'desinationPath' for retrieve jobs or 'tapeCopies' for archive jobs |
| jobStatusMessage | string Defines current status of job lifecycle |
| datasetList required | object Array of objects with keys: pid, files. The value for the pid key defines the dataset ID, the value for the files key is an array of file names. This array is either an empty array, implying that all files within the dataset are selected or an explicit list of dataset-relative file paths, which should be selected |
| jobResultObject | object Detailed return value after job is finished |
| id | string (ObjectID) ^[a-fA-F\d]{24}$ |
| createdAt | string <date-time> |
| updatedAt | string <date-time> |
{- "emailJobInitiator": "string",
- "type": "retrieve",
- "creationTime": "2019-08-24T14:15:22Z",
- "executionTime": "2019-08-24T14:15:22Z",
- "jobParams": { },
- "jobStatusMessage": "string",
- "datasetList": { },
- "jobResultObject": { },
- "id": "string",
- "createdAt": "2019-08-24T14:15:22Z",
- "updatedAt": "2019-08-24T14:15:22Z"
}{- "emailJobInitiator": "string",
- "type": "retrieve",
- "creationTime": "2019-08-24T14:15:22Z",
- "executionTime": "2019-08-24T14:15:22Z",
- "jobParams": { },
- "jobStatusMessage": "string",
- "datasetList": { },
- "jobResultObject": { },
- "id": "string",
- "createdAt": "2019-08-24T14:15:22Z",
- "updatedAt": "2019-08-24T14:15:22Z"
}| filter | string <JSON> Filter defining fields, where, include, order, offset, and limit - must be a JSON-encoded string ( |
{- "emailJobInitiator": "string",
- "type": "retrieve",
- "creationTime": "2019-08-24T14:15:22Z",
- "executionTime": "2019-08-24T14:15:22Z",
- "jobParams": { },
- "jobStatusMessage": "string",
- "datasetList": { },
- "jobResultObject": { },
- "id": "string",
- "createdAt": "2019-08-24T14:15:22Z",
- "updatedAt": "2019-08-24T14:15:22Z"
}| where | string <JSON> Criteria to match model instances |
An object of model property name/value pairs
| emailJobInitiator required | string The email of the person initiating the job request |
| type required | string Default: "retrieve" Type of job, e.g. archive, retrieve etc |
| creationTime | string <date-time> Time when job is created. Format according to chapter 5.6 internet date/time format in RFC 3339 |
| executionTime | string <date-time> Time when job should be executed. If not specified then the Job will be executed asap. Format according to chapter 5.6 internet date/time format in RFC 3339 |
| jobParams | object Object of key-value pairs defining job input parameters, e.g. 'desinationPath' for retrieve jobs or 'tapeCopies' for archive jobs |
| jobStatusMessage | string Defines current status of job lifecycle |
| datasetList required | object Array of objects with keys: pid, files. The value for the pid key defines the dataset ID, the value for the files key is an array of file names. This array is either an empty array, implying that all files within the dataset are selected or an explicit list of dataset-relative file paths, which should be selected |
| jobResultObject | object Detailed return value after job is finished |
| id | string (ObjectID) ^[a-fA-F\d]{24}$ |
| createdAt | string <date-time> |
| updatedAt | string <date-time> |
{- "emailJobInitiator": "string",
- "type": "retrieve",
- "creationTime": "2019-08-24T14:15:22Z",
- "executionTime": "2019-08-24T14:15:22Z",
- "jobParams": { },
- "jobStatusMessage": "string",
- "datasetList": { },
- "jobResultObject": { },
- "id": "string",
- "createdAt": "2019-08-24T14:15:22Z",
- "updatedAt": "2019-08-24T14:15:22Z"
}{- "count": 0
}| jobId | string |
| datasetFields | string <JSON> |
| include | string <JSON> |
| includeFields | string <JSON> |
{ }Container list all files and their attributes which make up a dataset. Usually Filled at the time the datasets metadata is created in the data catalog. Can be used by subsequent archiving processes to create the archived datasets.
| id required | string <JSON> OrigDatablock id |
| refresh | boolean |
{- "pid": "string",
- "owner": "string",
- "ownerEmail": "string",
- "orcidOfOwner": "string",
- "contactEmail": "string",
- "sourceFolder": "string",
- "sourceFolderHost": "string",
- "size": 0,
- "packedSize": 0,
- "numberOfFiles": 0,
- "numberOfFilesArchived": 0,
- "creationTime": "2019-08-24T14:15:22Z",
- "type": "string",
- "validationStatus": "string",
- "keywords": [
- "string"
], - "description": "string",
- "datasetName": "string",
- "classification": "string",
- "license": "string",
- "version": "string",
- "isPublished": true,
- "ownerGroup": "string",
- "accessGroups": [
- "string"
], - "createdBy": "string",
- "updatedBy": "string",
- "createdAt": "2019-08-24T14:15:22Z",
- "updatedAt": "2019-08-24T14:15:22Z",
- "publishedDataId": "string",
- "publisheddataId": "string",
- "datasetlifecycle": {
- "archivable": true,
- "retrievable": true,
- "publishable": true,
- "dateOfDiskPurging": "2019-08-24T14:15:22Z",
- "archiveRetentionTime": "2019-08-24T14:15:22Z",
- "dateOfPublishing": "2019-08-24T14:15:22Z",
- "isOnCentralDisk": true,
- "archiveStatusMessage": "string",
- "retrieveStatusMessage": "string",
- "archiveReturnMessage": { },
- "retrieveReturnMessage": { },
- "exportedTo": "string",
- "retrieveIntegrityCheck": true,
- "id": "string"
}, - "history": [
- {
- "id": "string"
}
], - "instrumentId": "string",
- "techniques": [
- {
- "pid": "string",
- "name": "string"
}
]
}Model instance data
| id | string (ObjectID) ^[a-fA-F\d]{24}$ |
| size required | number <double> Total size in bytes of all files contained in the dataFileList |
required | Array of objects (Datafile) List of files contained in the linked dataset. Files can be regular files, folders and softlinks. All file paths are relative paths with respect to the sourceFolder location of the linked dataset. |
| ownerGroup required | string Defines the group which owns the data, and therefore has unrestricted access to this data. Usually a pgroup like p12151 |
| accessGroups | Array of strings Optional additional groups which have read access to the data. Users which are member in one of the groups listed here are allowed to access this data. The special group 'public' makes data available to all users |
| createdBy | string Functional or user account name who created this instance |
| updatedBy | string Functional or user account name who last updated this instance |
| datasetId | string |
| rawDatasetId | string |
| derivedDatasetId | string |
| createdAt | string <date-time> |
| updatedAt | string <date-time> |
{- "id": "string",
- "size": 0,
- "dataFileList": [
- {
- "path": "string",
- "size": 0,
- "time": "2019-08-24T14:15:22Z",
- "chk": "string",
- "uid": "string",
- "gid": "string",
- "perm": "string"
}
], - "ownerGroup": "string",
- "accessGroups": [
- "string"
], - "createdBy": "string",
- "updatedBy": "string",
- "datasetId": "string",
- "rawDatasetId": "string",
- "derivedDatasetId": "string",
- "createdAt": "2019-08-24T14:15:22Z",
- "updatedAt": "2019-08-24T14:15:22Z"
}{- "id": "string",
- "size": 0,
- "dataFileList": [
- {
- "path": "string",
- "size": 0,
- "time": "2019-08-24T14:15:22Z",
- "chk": "string",
- "uid": "string",
- "gid": "string",
- "perm": "string"
}
], - "ownerGroup": "string",
- "accessGroups": [
- "string"
], - "createdBy": "string",
- "updatedBy": "string",
- "datasetId": "string",
- "rawDatasetId": "string",
- "derivedDatasetId": "string",
- "createdAt": "2019-08-24T14:15:22Z",
- "updatedAt": "2019-08-24T14:15:22Z"
}Model instance data
| id | string (ObjectID) ^[a-fA-F\d]{24}$ |
| size required | number <double> Total size in bytes of all files contained in the dataFileList |
required | Array of objects (Datafile) List of files contained in the linked dataset. Files can be regular files, folders and softlinks. All file paths are relative paths with respect to the sourceFolder location of the linked dataset. |
| ownerGroup required | string Defines the group which owns the data, and therefore has unrestricted access to this data. Usually a pgroup like p12151 |
| accessGroups | Array of strings Optional additional groups which have read access to the data. Users which are member in one of the groups listed here are allowed to access this data. The special group 'public' makes data available to all users |
| createdBy | string Functional or user account name who created this instance |
| updatedBy | string Functional or user account name who last updated this instance |
| datasetId | string |
| rawDatasetId | string |
| derivedDatasetId | string |
| createdAt | string <date-time> |
| updatedAt | string <date-time> |
{- "id": "string",
- "size": 0,
- "dataFileList": [
- {
- "path": "string",
- "size": 0,
- "time": "2019-08-24T14:15:22Z",
- "chk": "string",
- "uid": "string",
- "gid": "string",
- "perm": "string"
}
], - "ownerGroup": "string",
- "accessGroups": [
- "string"
], - "createdBy": "string",
- "updatedBy": "string",
- "datasetId": "string",
- "rawDatasetId": "string",
- "derivedDatasetId": "string",
- "createdAt": "2019-08-24T14:15:22Z",
- "updatedAt": "2019-08-24T14:15:22Z"
}{- "id": "string",
- "size": 0,
- "dataFileList": [
- {
- "path": "string",
- "size": 0,
- "time": "2019-08-24T14:15:22Z",
- "chk": "string",
- "uid": "string",
- "gid": "string",
- "perm": "string"
}
], - "ownerGroup": "string",
- "accessGroups": [
- "string"
], - "createdBy": "string",
- "updatedBy": "string",
- "datasetId": "string",
- "rawDatasetId": "string",
- "derivedDatasetId": "string",
- "createdAt": "2019-08-24T14:15:22Z",
- "updatedAt": "2019-08-24T14:15:22Z"
}Model instance data
| id | string (ObjectID) ^[a-fA-F\d]{24}$ |
| size required | number <double> Total size in bytes of all files contained in the dataFileList |
required | Array of objects (Datafile) List of files contained in the linked dataset. Files can be regular files, folders and softlinks. All file paths are relative paths with respect to the sourceFolder location of the linked dataset. |
| ownerGroup required | string Defines the group which owns the data, and therefore has unrestricted access to this data. Usually a pgroup like p12151 |
| accessGroups | Array of strings Optional additional groups which have read access to the data. Users which are member in one of the groups listed here are allowed to access this data. The special group 'public' makes data available to all users |
| createdBy | string Functional or user account name who created this instance |
| updatedBy | string Functional or user account name who last updated this instance |
| datasetId | string |
| rawDatasetId | string |
| derivedDatasetId | string |
| createdAt | string <date-time> |
| updatedAt | string <date-time> |
{- "id": "string",
- "size": 0,
- "dataFileList": [
- {
- "path": "string",
- "size": 0,
- "time": "2019-08-24T14:15:22Z",
- "chk": "string",
- "uid": "string",
- "gid": "string",
- "perm": "string"
}
], - "ownerGroup": "string",
- "accessGroups": [
- "string"
], - "createdBy": "string",
- "updatedBy": "string",
- "datasetId": "string",
- "rawDatasetId": "string",
- "derivedDatasetId": "string",
- "createdAt": "2019-08-24T14:15:22Z",
- "updatedAt": "2019-08-24T14:15:22Z"
}{- "id": "string",
- "size": 0,
- "dataFileList": [
- {
- "path": "string",
- "size": 0,
- "time": "2019-08-24T14:15:22Z",
- "chk": "string",
- "uid": "string",
- "gid": "string",
- "perm": "string"
}
], - "ownerGroup": "string",
- "accessGroups": [
- "string"
], - "createdBy": "string",
- "updatedBy": "string",
- "datasetId": "string",
- "rawDatasetId": "string",
- "derivedDatasetId": "string",
- "createdAt": "2019-08-24T14:15:22Z",
- "updatedAt": "2019-08-24T14:15:22Z"
}| filter | string <JSON> Filter defining fields, where, include, order, offset, and limit - must be a JSON-encoded string ( |
[- {
- "id": "string",
- "size": 0,
- "dataFileList": [
- {
- "path": "string",
- "size": 0,
- "time": "2019-08-24T14:15:22Z",
- "chk": "string",
- "uid": "string",
- "gid": "string",
- "perm": "string"
}
], - "ownerGroup": "string",
- "accessGroups": [
- "string"
], - "createdBy": "string",
- "updatedBy": "string",
- "datasetId": "string",
- "rawDatasetId": "string",
- "derivedDatasetId": "string",
- "createdAt": "2019-08-24T14:15:22Z",
- "updatedAt": "2019-08-24T14:15:22Z"
}
]Model instance data
| id | string (ObjectID) ^[a-fA-F\d]{24}$ |
| size required | number <double> Total size in bytes of all files contained in the dataFileList |
required | Array of objects (Datafile) List of files contained in the linked dataset. Files can be regular files, folders and softlinks. All file paths are relative paths with respect to the sourceFolder location of the linked dataset. |
| ownerGroup required | string Defines the group which owns the data, and therefore has unrestricted access to this data. Usually a pgroup like p12151 |
| accessGroups | Array of strings Optional additional groups which have read access to the data. Users which are member in one of the groups listed here are allowed to access this data. The special group 'public' makes data available to all users |
| createdBy | string Functional or user account name who created this instance |
| updatedBy | string Functional or user account name who last updated this instance |
| datasetId | string |
| rawDatasetId | string |
| derivedDatasetId | string |
| createdAt | string <date-time> |
| updatedAt | string <date-time> |
{- "id": "string",
- "size": 0,
- "dataFileList": [
- {
- "path": "string",
- "size": 0,
- "time": "2019-08-24T14:15:22Z",
- "chk": "string",
- "uid": "string",
- "gid": "string",
- "perm": "string"
}
], - "ownerGroup": "string",
- "accessGroups": [
- "string"
], - "createdBy": "string",
- "updatedBy": "string",
- "datasetId": "string",
- "rawDatasetId": "string",
- "derivedDatasetId": "string",
- "createdAt": "2019-08-24T14:15:22Z",
- "updatedAt": "2019-08-24T14:15:22Z"
}{- "id": "string",
- "size": 0,
- "dataFileList": [
- {
- "path": "string",
- "size": 0,
- "time": "2019-08-24T14:15:22Z",
- "chk": "string",
- "uid": "string",
- "gid": "string",
- "perm": "string"
}
], - "ownerGroup": "string",
- "accessGroups": [
- "string"
], - "createdBy": "string",
- "updatedBy": "string",
- "datasetId": "string",
- "rawDatasetId": "string",
- "derivedDatasetId": "string",
- "createdAt": "2019-08-24T14:15:22Z",
- "updatedAt": "2019-08-24T14:15:22Z"
}| where | string <JSON> Criteria to match model instances |
An object of model property name/value pairs
| id | string (ObjectID) ^[a-fA-F\d]{24}$ |
| size required | number <double> Total size in bytes of all files contained in the dataFileList |
required | Array of objects (Datafile) List of files contained in the linked dataset. Files can be regular files, folders and softlinks. All file paths are relative paths with respect to the sourceFolder location of the linked dataset. |
| ownerGroup required | string Defines the group which owns the data, and therefore has unrestricted access to this data. Usually a pgroup like p12151 |
| accessGroups | Array of strings Optional additional groups which have read access to the data. Users which are member in one of the groups listed here are allowed to access this data. The special group 'public' makes data available to all users |
| createdBy | string Functional or user account name who created this instance |
| updatedBy | string Functional or user account name who last updated this instance |
| datasetId | string |
| rawDatasetId | string |
| derivedDatasetId | string |
| createdAt | string <date-time> |
| updatedAt | string <date-time> |
{- "id": "string",
- "size": 0,
- "dataFileList": [
- {
- "path": "string",
- "size": 0,
- "time": "2019-08-24T14:15:22Z",
- "chk": "string",
- "uid": "string",
- "gid": "string",
- "perm": "string"
}
], - "ownerGroup": "string",
- "accessGroups": [
- "string"
], - "createdBy": "string",
- "updatedBy": "string",
- "datasetId": "string",
- "rawDatasetId": "string",
- "derivedDatasetId": "string",
- "createdAt": "2019-08-24T14:15:22Z",
- "updatedAt": "2019-08-24T14:15:22Z"
}{- "id": "string",
- "size": 0,
- "dataFileList": [
- {
- "path": "string",
- "size": 0,
- "time": "2019-08-24T14:15:22Z",
- "chk": "string",
- "uid": "string",
- "gid": "string",
- "perm": "string"
}
], - "ownerGroup": "string",
- "accessGroups": [
- "string"
], - "createdBy": "string",
- "updatedBy": "string",
- "datasetId": "string",
- "rawDatasetId": "string",
- "derivedDatasetId": "string",
- "createdAt": "2019-08-24T14:15:22Z",
- "updatedAt": "2019-08-24T14:15:22Z"
}| id required | string <JSON> Model id |
| filter | string <JSON> Filter defining fields and include - must be a JSON-encoded string ({"something":"value"}) |
{- "id": "string",
- "size": 0,
- "dataFileList": [
- {
- "path": "string",
- "size": 0,
- "time": "2019-08-24T14:15:22Z",
- "chk": "string",
- "uid": "string",
- "gid": "string",
- "perm": "string"
}
], - "ownerGroup": "string",
- "accessGroups": [
- "string"
], - "createdBy": "string",
- "updatedBy": "string",
- "datasetId": "string",
- "rawDatasetId": "string",
- "derivedDatasetId": "string",
- "createdAt": "2019-08-24T14:15:22Z",
- "updatedAt": "2019-08-24T14:15:22Z"
}| id required | string <JSON> Model id |
Model instance data
| id | string (ObjectID) ^[a-fA-F\d]{24}$ |
| size required | number <double> Total size in bytes of all files contained in the dataFileList |
required | Array of objects (Datafile) List of files contained in the linked dataset. Files can be regular files, folders and softlinks. All file paths are relative paths with respect to the sourceFolder location of the linked dataset. |
| ownerGroup required | string Defines the group which owns the data, and therefore has unrestricted access to this data. Usually a pgroup like p12151 |
| accessGroups | Array of strings Optional additional groups which have read access to the data. Users which are member in one of the groups listed here are allowed to access this data. The special group 'public' makes data available to all users |
| createdBy | string Functional or user account name who created this instance |
| updatedBy | string Functional or user account name who last updated this instance |
| datasetId | string |
| rawDatasetId | string |
| derivedDatasetId | string |
| createdAt | string <date-time> |
| updatedAt | string <date-time> |
{- "id": "string",
- "size": 0,
- "dataFileList": [
- {
- "path": "string",
- "size": 0,
- "time": "2019-08-24T14:15:22Z",
- "chk": "string",
- "uid": "string",
- "gid": "string",
- "perm": "string"
}
], - "ownerGroup": "string",
- "accessGroups": [
- "string"
], - "createdBy": "string",
- "updatedBy": "string",
- "datasetId": "string",
- "rawDatasetId": "string",
- "derivedDatasetId": "string",
- "createdAt": "2019-08-24T14:15:22Z",
- "updatedAt": "2019-08-24T14:15:22Z"
}{- "id": "string",
- "size": 0,
- "dataFileList": [
- {
- "path": "string",
- "size": 0,
- "time": "2019-08-24T14:15:22Z",
- "chk": "string",
- "uid": "string",
- "gid": "string",
- "perm": "string"
}
], - "ownerGroup": "string",
- "accessGroups": [
- "string"
], - "createdBy": "string",
- "updatedBy": "string",
- "datasetId": "string",
- "rawDatasetId": "string",
- "derivedDatasetId": "string",
- "createdAt": "2019-08-24T14:15:22Z",
- "updatedAt": "2019-08-24T14:15:22Z"
}| id required | string <JSON> OrigDatablock id |
An object of model property name/value pairs
| id | string (ObjectID) ^[a-fA-F\d]{24}$ |
| size required | number <double> Total size in bytes of all files contained in the dataFileList |
required | Array of objects (Datafile) List of files contained in the linked dataset. Files can be regular files, folders and softlinks. All file paths are relative paths with respect to the sourceFolder location of the linked dataset. |
| ownerGroup required | string Defines the group which owns the data, and therefore has unrestricted access to this data. Usually a pgroup like p12151 |
| accessGroups | Array of strings Optional additional groups which have read access to the data. Users which are member in one of the groups listed here are allowed to access this data. The special group 'public' makes data available to all users |
| createdBy | string Functional or user account name who created this instance |
| updatedBy | string Functional or user account name who last updated this instance |
| datasetId | string |
| rawDatasetId | string |
| derivedDatasetId | string |
| createdAt | string <date-time> |
| updatedAt | string <date-time> |
{- "id": "string",
- "size": 0,
- "dataFileList": [
- {
- "path": "string",
- "size": 0,
- "time": "2019-08-24T14:15:22Z",
- "chk": "string",
- "uid": "string",
- "gid": "string",
- "perm": "string"
}
], - "ownerGroup": "string",
- "accessGroups": [
- "string"
], - "createdBy": "string",
- "updatedBy": "string",
- "datasetId": "string",
- "rawDatasetId": "string",
- "derivedDatasetId": "string",
- "createdAt": "2019-08-24T14:15:22Z",
- "updatedAt": "2019-08-24T14:15:22Z"
}{- "id": "string",
- "size": 0,
- "dataFileList": [
- {
- "path": "string",
- "size": 0,
- "time": "2019-08-24T14:15:22Z",
- "chk": "string",
- "uid": "string",
- "gid": "string",
- "perm": "string"
}
], - "ownerGroup": "string",
- "accessGroups": [
- "string"
], - "createdBy": "string",
- "updatedBy": "string",
- "datasetId": "string",
- "rawDatasetId": "string",
- "derivedDatasetId": "string",
- "createdAt": "2019-08-24T14:15:22Z",
- "updatedAt": "2019-08-24T14:15:22Z"
}| id required | string <JSON> Model id |
Model instance data
| id | string (ObjectID) ^[a-fA-F\d]{24}$ |
| size required | number <double> Total size in bytes of all files contained in the dataFileList |
required | Array of objects (Datafile) List of files contained in the linked dataset. Files can be regular files, folders and softlinks. All file paths are relative paths with respect to the sourceFolder location of the linked dataset. |
| ownerGroup required | string Defines the group which owns the data, and therefore has unrestricted access to this data. Usually a pgroup like p12151 |
| accessGroups | Array of strings Optional additional groups which have read access to the data. Users which are member in one of the groups listed here are allowed to access this data. The special group 'public' makes data available to all users |
| createdBy | string Functional or user account name who created this instance |
| updatedBy | string Functional or user account name who last updated this instance |
| datasetId | string |
| rawDatasetId | string |
| derivedDatasetId | string |
| createdAt | string <date-time> |
| updatedAt | string <date-time> |
{- "id": "string",
- "size": 0,
- "dataFileList": [
- {
- "path": "string",
- "size": 0,
- "time": "2019-08-24T14:15:22Z",
- "chk": "string",
- "uid": "string",
- "gid": "string",
- "perm": "string"
}
], - "ownerGroup": "string",
- "accessGroups": [
- "string"
], - "createdBy": "string",
- "updatedBy": "string",
- "datasetId": "string",
- "rawDatasetId": "string",
- "derivedDatasetId": "string",
- "createdAt": "2019-08-24T14:15:22Z",
- "updatedAt": "2019-08-24T14:15:22Z"
}{- "id": "string",
- "size": 0,
- "dataFileList": [
- {
- "path": "string",
- "size": 0,
- "time": "2019-08-24T14:15:22Z",
- "chk": "string",
- "uid": "string",
- "gid": "string",
- "perm": "string"
}
], - "ownerGroup": "string",
- "accessGroups": [
- "string"
], - "createdBy": "string",
- "updatedBy": "string",
- "datasetId": "string",
- "rawDatasetId": "string",
- "derivedDatasetId": "string",
- "createdAt": "2019-08-24T14:15:22Z",
- "updatedAt": "2019-08-24T14:15:22Z"
}| filter | string <JSON> Filter defining fields, where, include, order, offset, and limit - must be a JSON-encoded string ( |
{- "id": "string",
- "size": 0,
- "dataFileList": [
- {
- "path": "string",
- "size": 0,
- "time": "2019-08-24T14:15:22Z",
- "chk": "string",
- "uid": "string",
- "gid": "string",
- "perm": "string"
}
], - "ownerGroup": "string",
- "accessGroups": [
- "string"
], - "createdBy": "string",
- "updatedBy": "string",
- "datasetId": "string",
- "rawDatasetId": "string",
- "derivedDatasetId": "string",
- "createdAt": "2019-08-24T14:15:22Z",
- "updatedAt": "2019-08-24T14:15:22Z"
}| where | string <JSON> Criteria to match model instances |
An object of model property name/value pairs
| id | string (ObjectID) ^[a-fA-F\d]{24}$ |
| size required | number <double> Total size in bytes of all files contained in the dataFileList |
required | Array of objects (Datafile) List of files contained in the linked dataset. Files can be regular files, folders and softlinks. All file paths are relative paths with respect to the sourceFolder location of the linked dataset. |
| ownerGroup required | string Defines the group which owns the data, and therefore has unrestricted access to this data. Usually a pgroup like p12151 |
| accessGroups | Array of strings Optional additional groups which have read access to the data. Users which are member in one of the groups listed here are allowed to access this data. The special group 'public' makes data available to all users |
| createdBy | string Functional or user account name who created this instance |
| updatedBy | string Functional or user account name who last updated this instance |
| datasetId | string |
| rawDatasetId | string |
| derivedDatasetId | string |
| createdAt | string <date-time> |
| updatedAt | string <date-time> |
{- "id": "string",
- "size": 0,
- "dataFileList": [
- {
- "path": "string",
- "size": 0,
- "time": "2019-08-24T14:15:22Z",
- "chk": "string",
- "uid": "string",
- "gid": "string",
- "perm": "string"
}
], - "ownerGroup": "string",
- "accessGroups": [
- "string"
], - "createdBy": "string",
- "updatedBy": "string",
- "datasetId": "string",
- "rawDatasetId": "string",
- "derivedDatasetId": "string",
- "createdAt": "2019-08-24T14:15:22Z",
- "updatedAt": "2019-08-24T14:15:22Z"
}{- "count": 0
}{ }{ }| fields | string <JSON> Define datasetId field to select a dataset and/or the filenameExp field to define a search regexp for file names. |
| limits | string <JSON> Define further query parameters like skip, limit, order |
{ }| name required | string The name of the Logbook |
| filters required | string Filter rison object, keys: textSearch, showBotMessages, showUserMessages, showImages, skip, limit, sortField |
{- "name": "string",
- "roomId": "string",
- "messages": [
- { }
]
}| id required | string <JSON> Attachment id |
| refresh | boolean |
{- "pid": "string",
- "owner": "string",
- "ownerEmail": "string",
- "orcidOfOwner": "string",
- "contactEmail": "string",
- "sourceFolder": "string",
- "sourceFolderHost": "string",
- "size": 0,
- "packedSize": 0,
- "numberOfFiles": 0,
- "numberOfFilesArchived": 0,
- "creationTime": "2019-08-24T14:15:22Z",
- "type": "string",
- "validationStatus": "string",
- "keywords": [
- "string"
], - "description": "string",
- "datasetName": "string",
- "classification": "string",
- "license": "string",
- "version": "string",
- "isPublished": true,
- "ownerGroup": "string",
- "accessGroups": [
- "string"
], - "createdBy": "string",
- "updatedBy": "string",
- "createdAt": "2019-08-24T14:15:22Z",
- "updatedAt": "2019-08-24T14:15:22Z",
- "publishedDataId": "string",
- "publisheddataId": "string",
- "datasetlifecycle": {
- "archivable": true,
- "retrievable": true,
- "publishable": true,
- "dateOfDiskPurging": "2019-08-24T14:15:22Z",
- "archiveRetentionTime": "2019-08-24T14:15:22Z",
- "dateOfPublishing": "2019-08-24T14:15:22Z",
- "isOnCentralDisk": true,
- "archiveStatusMessage": "string",
- "retrieveStatusMessage": "string",
- "archiveReturnMessage": { },
- "retrieveReturnMessage": { },
- "exportedTo": "string",
- "retrieveIntegrityCheck": true,
- "id": "string"
}, - "history": [
- {
- "id": "string"
}
], - "instrumentId": "string",
- "techniques": [
- {
- "pid": "string",
- "name": "string"
}
]
}| id required | string <JSON> Attachment id |
| refresh | boolean |
{- "sampleId": "string",
- "owner": "string",
- "description": "string",
- "createdAt": "2019-08-24T14:15:22Z",
- "sampleCharacteristics": { },
- "isPublished": true,
- "ownerGroup": "string",
- "accessGroups": [
- "string"
], - "createdBy": "string",
- "updatedBy": "string",
- "datasetsId": "string",
- "datasetId": "string",
- "rawDatasetId": "string",
- "derivedDatasetId": "string",
- "updatedAt": "2019-08-24T14:15:22Z"
}| id required | string <JSON> Attachment id |
| refresh | boolean |
{- "proposalId": "string",
- "pi_email": "string",
- "pi_firstname": "string",
- "pi_lastname": "string",
- "email": "string",
- "firstname": "string",
- "lastname": "string",
- "title": "string",
- "abstract": "string",
- "startTime": "2019-08-24T14:15:22Z",
- "endTime": "2019-08-24T14:15:22Z",
- "ownerGroup": "string",
- "accessGroups": [
- "string"
], - "createdBy": "string",
- "updatedBy": "string",
- "createdAt": "2019-08-24T14:15:22Z",
- "updatedAt": "2019-08-24T14:15:22Z",
- "MeasurementPeriodList": [
- {
- "id": "string",
- "instrument": "string",
- "start": "2019-08-24T14:15:22Z",
- "end": "2019-08-24T14:15:22Z",
- "comment": "string"
}
]
}Model instance data
| thumbnail required | string Default: "retrieve" Contains a thumbnail preview in base64 encoded png format for a given dataset |
| caption | string Default: "" Attachment caption to show in catanie |
| ownerGroup required | string Defines the group which owns the data, and therefore has unrestricted access to this data. Usually a pgroup like p12151 |
| accessGroups | Array of strings Optional additional groups which have read access to the data. Users which are member in one of the groups listed here are allowed to access this data. The special group 'public' makes data available to all users |
| createdBy | string Functional or user account name who created this instance |
| updatedBy | string Functional or user account name who last updated this instance |
| id | string (ObjectID) ^[a-fA-F\d]{24}$ |
| datasetId | string |
| sampleId | string |
| proposalId | string |
| rawDatasetId | string |
| derivedDatasetId | string |
| createdAt | string <date-time> |
| updatedAt | string <date-time> |
{- "thumbnail": "retrieve",
- "caption": "",
- "ownerGroup": "string",
- "accessGroups": [
- "string"
], - "createdBy": "string",
- "updatedBy": "string",
- "id": "string",
- "datasetId": "string",
- "sampleId": "string",
- "proposalId": "string",
- "rawDatasetId": "string",
- "derivedDatasetId": "string",
- "createdAt": "2019-08-24T14:15:22Z",
- "updatedAt": "2019-08-24T14:15:22Z"
}{- "thumbnail": "retrieve",
- "caption": "",
- "ownerGroup": "string",
- "accessGroups": [
- "string"
], - "createdBy": "string",
- "updatedBy": "string",
- "id": "string",
- "datasetId": "string",
- "sampleId": "string",
- "proposalId": "string",
- "rawDatasetId": "string",
- "derivedDatasetId": "string",
- "createdAt": "2019-08-24T14:15:22Z",
- "updatedAt": "2019-08-24T14:15:22Z"
}Model instance data
| thumbnail required | string Default: "retrieve" Contains a thumbnail preview in base64 encoded png format for a given dataset |
| caption | string Default: "" Attachment caption to show in catanie |
| ownerGroup required | string Defines the group which owns the data, and therefore has unrestricted access to this data. Usually a pgroup like p12151 |
| accessGroups | Array of strings Optional additional groups which have read access to the data. Users which are member in one of the groups listed here are allowed to access this data. The special group 'public' makes data available to all users |
| createdBy | string Functional or user account name who created this instance |
| updatedBy | string Functional or user account name who last updated this instance |
| id | string (ObjectID) ^[a-fA-F\d]{24}$ |
| datasetId | string |
| sampleId | string |
| proposalId | string |
| rawDatasetId | string |
| derivedDatasetId | string |
| createdAt | string <date-time> |
| updatedAt | string <date-time> |
{- "thumbnail": "retrieve",
- "caption": "",
- "ownerGroup": "string",
- "accessGroups": [
- "string"
], - "createdBy": "string",
- "updatedBy": "string",
- "id": "string",
- "datasetId": "string",
- "sampleId": "string",
- "proposalId": "string",
- "rawDatasetId": "string",
- "derivedDatasetId": "string",
- "createdAt": "2019-08-24T14:15:22Z",
- "updatedAt": "2019-08-24T14:15:22Z"
}{- "thumbnail": "retrieve",
- "caption": "",
- "ownerGroup": "string",
- "accessGroups": [
- "string"
], - "createdBy": "string",
- "updatedBy": "string",
- "id": "string",
- "datasetId": "string",
- "sampleId": "string",
- "proposalId": "string",
- "rawDatasetId": "string",
- "derivedDatasetId": "string",
- "createdAt": "2019-08-24T14:15:22Z",
- "updatedAt": "2019-08-24T14:15:22Z"
}Model instance data
| thumbnail required | string Default: "retrieve" Contains a thumbnail preview in base64 encoded png format for a given dataset |
| caption | string Default: "" Attachment caption to show in catanie |
| ownerGroup required | string Defines the group which owns the data, and therefore has unrestricted access to this data. Usually a pgroup like p12151 |
| accessGroups | Array of strings Optional additional groups which have read access to the data. Users which are member in one of the groups listed here are allowed to access this data. The special group 'public' makes data available to all users |
| createdBy | string Functional or user account name who created this instance |
| updatedBy | string Functional or user account name who last updated this instance |
| id | string (ObjectID) ^[a-fA-F\d]{24}$ |
| datasetId | string |
| sampleId | string |
| proposalId | string |
| rawDatasetId | string |
| derivedDatasetId | string |
| createdAt | string <date-time> |
| updatedAt | string <date-time> |
{- "thumbnail": "retrieve",
- "caption": "",
- "ownerGroup": "string",
- "accessGroups": [
- "string"
], - "createdBy": "string",
- "updatedBy": "string",
- "id": "string",
- "datasetId": "string",
- "sampleId": "string",
- "proposalId": "string",
- "rawDatasetId": "string",
- "derivedDatasetId": "string",
- "createdAt": "2019-08-24T14:15:22Z",
- "updatedAt": "2019-08-24T14:15:22Z"
}{- "thumbnail": "retrieve",
- "caption": "",
- "ownerGroup": "string",
- "accessGroups": [
- "string"
], - "createdBy": "string",
- "updatedBy": "string",
- "id": "string",
- "datasetId": "string",
- "sampleId": "string",
- "proposalId": "string",
- "rawDatasetId": "string",
- "derivedDatasetId": "string",
- "createdAt": "2019-08-24T14:15:22Z",
- "updatedAt": "2019-08-24T14:15:22Z"
}| filter | string <JSON> Filter defining fields, where, include, order, offset, and limit - must be a JSON-encoded string ( |
[- {
- "thumbnail": "retrieve",
- "caption": "",
- "ownerGroup": "string",
- "accessGroups": [
- "string"
], - "createdBy": "string",
- "updatedBy": "string",
- "id": "string",
- "datasetId": "string",
- "sampleId": "string",
- "proposalId": "string",
- "rawDatasetId": "string",
- "derivedDatasetId": "string",
- "createdAt": "2019-08-24T14:15:22Z",
- "updatedAt": "2019-08-24T14:15:22Z"
}
]Model instance data
| thumbnail required | string Default: "retrieve" Contains a thumbnail preview in base64 encoded png format for a given dataset |
| caption | string Default: "" Attachment caption to show in catanie |
| ownerGroup required | string Defines the group which owns the data, and therefore has unrestricted access to this data. Usually a pgroup like p12151 |
| accessGroups | Array of strings Optional additional groups which have read access to the data. Users which are member in one of the groups listed here are allowed to access this data. The special group 'public' makes data available to all users |
| createdBy | string Functional or user account name who created this instance |
| updatedBy | string Functional or user account name who last updated this instance |
| id | string (ObjectID) ^[a-fA-F\d]{24}$ |
| datasetId | string |
| sampleId | string |
| proposalId | string |
| rawDatasetId | string |
| derivedDatasetId | string |
| createdAt | string <date-time> |
| updatedAt | string <date-time> |
{- "thumbnail": "retrieve",
- "caption": "",
- "ownerGroup": "string",
- "accessGroups": [
- "string"
], - "createdBy": "string",
- "updatedBy": "string",
- "id": "string",
- "datasetId": "string",
- "sampleId": "string",
- "proposalId": "string",
- "rawDatasetId": "string",
- "derivedDatasetId": "string",
- "createdAt": "2019-08-24T14:15:22Z",
- "updatedAt": "2019-08-24T14:15:22Z"
}{- "thumbnail": "retrieve",
- "caption": "",
- "ownerGroup": "string",
- "accessGroups": [
- "string"
], - "createdBy": "string",
- "updatedBy": "string",
- "id": "string",
- "datasetId": "string",
- "sampleId": "string",
- "proposalId": "string",
- "rawDatasetId": "string",
- "derivedDatasetId": "string",
- "createdAt": "2019-08-24T14:15:22Z",
- "updatedAt": "2019-08-24T14:15:22Z"
}| where | string <JSON> Criteria to match model instances |
An object of model property name/value pairs
| thumbnail required | string Default: "retrieve" Contains a thumbnail preview in base64 encoded png format for a given dataset |
| caption | string Default: "" Attachment caption to show in catanie |
| ownerGroup required | string Defines the group which owns the data, and therefore has unrestricted access to this data. Usually a pgroup like p12151 |
| accessGroups | Array of strings Optional additional groups which have read access to the data. Users which are member in one of the groups listed here are allowed to access this data. The special group 'public' makes data available to all users |
| createdBy | string Functional or user account name who created this instance |
| updatedBy | string Functional or user account name who last updated this instance |
| id | string (ObjectID) ^[a-fA-F\d]{24}$ |
| datasetId | string |
| sampleId | string |
| proposalId | string |
| rawDatasetId | string |
| derivedDatasetId | string |
| createdAt | string <date-time> |
| updatedAt | string <date-time> |
{- "thumbnail": "retrieve",
- "caption": "",
- "ownerGroup": "string",
- "accessGroups": [
- "string"
], - "createdBy": "string",
- "updatedBy": "string",
- "id": "string",
- "datasetId": "string",
- "sampleId": "string",
- "proposalId": "string",
- "rawDatasetId": "string",
- "derivedDatasetId": "string",
- "createdAt": "2019-08-24T14:15:22Z",
- "updatedAt": "2019-08-24T14:15:22Z"
}{- "thumbnail": "retrieve",
- "caption": "",
- "ownerGroup": "string",
- "accessGroups": [
- "string"
], - "createdBy": "string",
- "updatedBy": "string",
- "id": "string",
- "datasetId": "string",
- "sampleId": "string",
- "proposalId": "string",
- "rawDatasetId": "string",
- "derivedDatasetId": "string",
- "createdAt": "2019-08-24T14:15:22Z",
- "updatedAt": "2019-08-24T14:15:22Z"
}| id required | string <JSON> Model id |
| filter | string <JSON> Filter defining fields and include - must be a JSON-encoded string ({"something":"value"}) |
{- "thumbnail": "retrieve",
- "caption": "",
- "ownerGroup": "string",
- "accessGroups": [
- "string"
], - "createdBy": "string",
- "updatedBy": "string",
- "id": "string",
- "datasetId": "string",
- "sampleId": "string",
- "proposalId": "string",
- "rawDatasetId": "string",
- "derivedDatasetId": "string",
- "createdAt": "2019-08-24T14:15:22Z",
- "updatedAt": "2019-08-24T14:15:22Z"
}| id required | string <JSON> Model id |
Model instance data
| thumbnail required | string Default: "retrieve" Contains a thumbnail preview in base64 encoded png format for a given dataset |
| caption | string Default: "" Attachment caption to show in catanie |
| ownerGroup required | string Defines the group which owns the data, and therefore has unrestricted access to this data. Usually a pgroup like p12151 |
| accessGroups | Array of strings Optional additional groups which have read access to the data. Users which are member in one of the groups listed here are allowed to access this data. The special group 'public' makes data available to all users |
| createdBy | string Functional or user account name who created this instance |
| updatedBy | string Functional or user account name who last updated this instance |
| id | string (ObjectID) ^[a-fA-F\d]{24}$ |
| datasetId | string |
| sampleId | string |
| proposalId | string |
| rawDatasetId | string |
| derivedDatasetId | string |
| createdAt | string <date-time> |
| updatedAt | string <date-time> |
{- "thumbnail": "retrieve",
- "caption": "",
- "ownerGroup": "string",
- "accessGroups": [
- "string"
], - "createdBy": "string",
- "updatedBy": "string",
- "id": "string",
- "datasetId": "string",
- "sampleId": "string",
- "proposalId": "string",
- "rawDatasetId": "string",
- "derivedDatasetId": "string",
- "createdAt": "2019-08-24T14:15:22Z",
- "updatedAt": "2019-08-24T14:15:22Z"
}{- "thumbnail": "retrieve",
- "caption": "",
- "ownerGroup": "string",
- "accessGroups": [
- "string"
], - "createdBy": "string",
- "updatedBy": "string",
- "id": "string",
- "datasetId": "string",
- "sampleId": "string",
- "proposalId": "string",
- "rawDatasetId": "string",
- "derivedDatasetId": "string",
- "createdAt": "2019-08-24T14:15:22Z",
- "updatedAt": "2019-08-24T14:15:22Z"
}| id required | string <JSON> Attachment id |
An object of model property name/value pairs
| thumbnail required | string Default: "retrieve" Contains a thumbnail preview in base64 encoded png format for a given dataset |
| caption | string Default: "" Attachment caption to show in catanie |
| ownerGroup required | string Defines the group which owns the data, and therefore has unrestricted access to this data. Usually a pgroup like p12151 |
| accessGroups | Array of strings Optional additional groups which have read access to the data. Users which are member in one of the groups listed here are allowed to access this data. The special group 'public' makes data available to all users |
| createdBy | string Functional or user account name who created this instance |
| updatedBy | string Functional or user account name who last updated this instance |
| id | string (ObjectID) ^[a-fA-F\d]{24}$ |
| datasetId | string |
| sampleId | string |
| proposalId | string |
| rawDatasetId | string |
| derivedDatasetId | string |
| createdAt | string <date-time> |
| updatedAt | string <date-time> |
{- "thumbnail": "retrieve",
- "caption": "",
- "ownerGroup": "string",
- "accessGroups": [
- "string"
], - "createdBy": "string",
- "updatedBy": "string",
- "id": "string",
- "datasetId": "string",
- "sampleId": "string",
- "proposalId": "string",
- "rawDatasetId": "string",
- "derivedDatasetId": "string",
- "createdAt": "2019-08-24T14:15:22Z",
- "updatedAt": "2019-08-24T14:15:22Z"
}{- "thumbnail": "retrieve",
- "caption": "",
- "ownerGroup": "string",
- "accessGroups": [
- "string"
], - "createdBy": "string",
- "updatedBy": "string",
- "id": "string",
- "datasetId": "string",
- "sampleId": "string",
- "proposalId": "string",
- "rawDatasetId": "string",
- "derivedDatasetId": "string",
- "createdAt": "2019-08-24T14:15:22Z",
- "updatedAt": "2019-08-24T14:15:22Z"
}| id required | string <JSON> Model id |
Model instance data
| thumbnail required | string Default: "retrieve" Contains a thumbnail preview in base64 encoded png format for a given dataset |
| caption | string Default: "" Attachment caption to show in catanie |
| ownerGroup required | string Defines the group which owns the data, and therefore has unrestricted access to this data. Usually a pgroup like p12151 |
| accessGroups | Array of strings Optional additional groups which have read access to the data. Users which are member in one of the groups listed here are allowed to access this data. The special group 'public' makes data available to all users |
| createdBy | string Functional or user account name who created this instance |
| updatedBy | string Functional or user account name who last updated this instance |
| id | string (ObjectID) ^[a-fA-F\d]{24}$ |
| datasetId | string |
| sampleId | string |
| proposalId | string |
| rawDatasetId | string |
| derivedDatasetId | string |
| createdAt | string <date-time> |
| updatedAt | string <date-time> |
{- "thumbnail": "retrieve",
- "caption": "",
- "ownerGroup": "string",
- "accessGroups": [
- "string"
], - "createdBy": "string",
- "updatedBy": "string",
- "id": "string",
- "datasetId": "string",
- "sampleId": "string",
- "proposalId": "string",
- "rawDatasetId": "string",
- "derivedDatasetId": "string",
- "createdAt": "2019-08-24T14:15:22Z",
- "updatedAt": "2019-08-24T14:15:22Z"
}{- "thumbnail": "retrieve",
- "caption": "",
- "ownerGroup": "string",
- "accessGroups": [
- "string"
], - "createdBy": "string",
- "updatedBy": "string",
- "id": "string",
- "datasetId": "string",
- "sampleId": "string",
- "proposalId": "string",
- "rawDatasetId": "string",
- "derivedDatasetId": "string",
- "createdAt": "2019-08-24T14:15:22Z",
- "updatedAt": "2019-08-24T14:15:22Z"
}| filter | string <JSON> Filter defining fields, where, include, order, offset, and limit - must be a JSON-encoded string ( |
{- "thumbnail": "retrieve",
- "caption": "",
- "ownerGroup": "string",
- "accessGroups": [
- "string"
], - "createdBy": "string",
- "updatedBy": "string",
- "id": "string",
- "datasetId": "string",
- "sampleId": "string",
- "proposalId": "string",
- "rawDatasetId": "string",
- "derivedDatasetId": "string",
- "createdAt": "2019-08-24T14:15:22Z",
- "updatedAt": "2019-08-24T14:15:22Z"
}| where | string <JSON> Criteria to match model instances |
An object of model property name/value pairs
| thumbnail required | string Default: "retrieve" Contains a thumbnail preview in base64 encoded png format for a given dataset |
| caption | string Default: "" Attachment caption to show in catanie |
| ownerGroup required | string Defines the group which owns the data, and therefore has unrestricted access to this data. Usually a pgroup like p12151 |
| accessGroups | Array of strings Optional additional groups which have read access to the data. Users which are member in one of the groups listed here are allowed to access this data. The special group 'public' makes data available to all users |
| createdBy | string Functional or user account name who created this instance |
| updatedBy | string Functional or user account name who last updated this instance |
| id | string (ObjectID) ^[a-fA-F\d]{24}$ |
| datasetId | string |
| sampleId | string |
| proposalId | string |
| rawDatasetId | string |
| derivedDatasetId | string |
| createdAt | string <date-time> |
| updatedAt | string <date-time> |
{- "thumbnail": "retrieve",
- "caption": "",
- "ownerGroup": "string",
- "accessGroups": [
- "string"
], - "createdBy": "string",
- "updatedBy": "string",
- "id": "string",
- "datasetId": "string",
- "sampleId": "string",
- "proposalId": "string",
- "rawDatasetId": "string",
- "derivedDatasetId": "string",
- "createdAt": "2019-08-24T14:15:22Z",
- "updatedAt": "2019-08-24T14:15:22Z"
}{- "count": 0
}{ }{ }| id required | string <JSON> UserSetting id |
| refresh | boolean |
{- "realm": "string",
- "username": "string",
- "email": "string",
- "emailVerified": true,
- "id": "string"
}Model instance data
| columns | Array of objects |
| datasetCount | number <double> Default: 25 |
| jobCount | number <double> Default: 25 |
| id | string (ObjectID) ^[a-fA-F\d]{24}$ |
| userId | string (ObjectID) ^[a-fA-F\d]{24}$ |
{- "columns": [
- { }
], - "datasetCount": 25,
- "jobCount": 25,
- "id": "string",
- "userId": "string"
}{- "columns": [
- { }
], - "datasetCount": 25,
- "jobCount": 25,
- "id": "string",
- "userId": "string"
}Model instance data
| columns | Array of objects |
| datasetCount | number <double> Default: 25 |
| jobCount | number <double> Default: 25 |
| id | string (ObjectID) ^[a-fA-F\d]{24}$ |
| userId | string (ObjectID) ^[a-fA-F\d]{24}$ |
{- "columns": [
- { }
], - "datasetCount": 25,
- "jobCount": 25,
- "id": "string",
- "userId": "string"
}{- "columns": [
- { }
], - "datasetCount": 25,
- "jobCount": 25,
- "id": "string",
- "userId": "string"
}Model instance data
| columns | Array of objects |
| datasetCount | number <double> Default: 25 |
| jobCount | number <double> Default: 25 |
| id | string (ObjectID) ^[a-fA-F\d]{24}$ |
| userId | string (ObjectID) ^[a-fA-F\d]{24}$ |
{- "columns": [
- { }
], - "datasetCount": 25,
- "jobCount": 25,
- "id": "string",
- "userId": "string"
}{- "columns": [
- { }
], - "datasetCount": 25,
- "jobCount": 25,
- "id": "string",
- "userId": "string"
}| filter | string <JSON> Filter defining fields, where, include, order, offset, and limit - must be a JSON-encoded string ( |
[- {
- "columns": [
- { }
], - "datasetCount": 25,
- "jobCount": 25,
- "id": "string",
- "userId": "string"
}
]Model instance data
| columns | Array of objects |
| datasetCount | number <double> Default: 25 |
| jobCount | number <double> Default: 25 |
| id | string (ObjectID) ^[a-fA-F\d]{24}$ |
| userId | string (ObjectID) ^[a-fA-F\d]{24}$ |
{- "columns": [
- { }
], - "datasetCount": 25,
- "jobCount": 25,
- "id": "string",
- "userId": "string"
}{- "columns": [
- { }
], - "datasetCount": 25,
- "jobCount": 25,
- "id": "string",
- "userId": "string"
}| where | string <JSON> Criteria to match model instances |
An object of model property name/value pairs
| columns | Array of objects |
| datasetCount | number <double> Default: 25 |
| jobCount | number <double> Default: 25 |
| id | string (ObjectID) ^[a-fA-F\d]{24}$ |
| userId | string (ObjectID) ^[a-fA-F\d]{24}$ |
{- "columns": [
- { }
], - "datasetCount": 25,
- "jobCount": 25,
- "id": "string",
- "userId": "string"
}{- "columns": [
- { }
], - "datasetCount": 25,
- "jobCount": 25,
- "id": "string",
- "userId": "string"
}| id required | string <JSON> Model id |
| filter | string <JSON> Filter defining fields and include - must be a JSON-encoded string ({"something":"value"}) |
{- "columns": [
- { }
], - "datasetCount": 25,
- "jobCount": 25,
- "id": "string",
- "userId": "string"
}| id required | string <JSON> Model id |
Model instance data
| columns | Array of objects |
| datasetCount | number <double> Default: 25 |
| jobCount | number <double> Default: 25 |
| id | string (ObjectID) ^[a-fA-F\d]{24}$ |
| userId | string (ObjectID) ^[a-fA-F\d]{24}$ |
{- "columns": [
- { }
], - "datasetCount": 25,
- "jobCount": 25,
- "id": "string",
- "userId": "string"
}{- "columns": [
- { }
], - "datasetCount": 25,
- "jobCount": 25,
- "id": "string",
- "userId": "string"
}| id required | string <JSON> UserSetting id |
An object of model property name/value pairs
| columns | Array of objects |
| datasetCount | number <double> Default: 25 |
| jobCount | number <double> Default: 25 |
| id | string (ObjectID) ^[a-fA-F\d]{24}$ |
| userId | string (ObjectID) ^[a-fA-F\d]{24}$ |
{- "columns": [
- { }
], - "datasetCount": 25,
- "jobCount": 25,
- "id": "string",
- "userId": "string"
}{- "columns": [
- { }
], - "datasetCount": 25,
- "jobCount": 25,
- "id": "string",
- "userId": "string"
}| id required | string <JSON> Model id |
Model instance data
| columns | Array of objects |
| datasetCount | number <double> Default: 25 |
| jobCount | number <double> Default: 25 |
| id | string (ObjectID) ^[a-fA-F\d]{24}$ |
| userId | string (ObjectID) ^[a-fA-F\d]{24}$ |
{- "columns": [
- { }
], - "datasetCount": 25,
- "jobCount": 25,
- "id": "string",
- "userId": "string"
}{- "columns": [
- { }
], - "datasetCount": 25,
- "jobCount": 25,
- "id": "string",
- "userId": "string"
}| filter | string <JSON> Filter defining fields, where, include, order, offset, and limit - must be a JSON-encoded string ( |
{- "columns": [
- { }
], - "datasetCount": 25,
- "jobCount": 25,
- "id": "string",
- "userId": "string"
}| where | string <JSON> Criteria to match model instances |
An object of model property name/value pairs
| columns | Array of objects |
| datasetCount | number <double> Default: 25 |
| jobCount | number <double> Default: 25 |
| id | string (ObjectID) ^[a-fA-F\d]{24}$ |
| userId | string (ObjectID) ^[a-fA-F\d]{24}$ |
{- "columns": [
- { }
], - "datasetCount": 25,
- "jobCount": 25,
- "id": "string",
- "userId": "string"
}{- "count": 0
}| id required | string <JSON> Instrument id |
| fk required | string <JSON> Foreign key for datasets |
{- "pid": "string",
- "owner": "string",
- "ownerEmail": "string",
- "orcidOfOwner": "string",
- "contactEmail": "string",
- "sourceFolder": "string",
- "sourceFolderHost": "string",
- "size": 0,
- "packedSize": 0,
- "numberOfFiles": 0,
- "numberOfFilesArchived": 0,
- "creationTime": "2019-08-24T14:15:22Z",
- "type": "string",
- "validationStatus": "string",
- "keywords": [
- "string"
], - "description": "string",
- "datasetName": "string",
- "classification": "string",
- "license": "string",
- "version": "string",
- "isPublished": true,
- "ownerGroup": "string",
- "accessGroups": [
- "string"
], - "createdBy": "string",
- "updatedBy": "string",
- "createdAt": "2019-08-24T14:15:22Z",
- "updatedAt": "2019-08-24T14:15:22Z",
- "publishedDataId": "string",
- "publisheddataId": "string",
- "datasetlifecycle": {
- "archivable": true,
- "retrievable": true,
- "publishable": true,
- "dateOfDiskPurging": "2019-08-24T14:15:22Z",
- "archiveRetentionTime": "2019-08-24T14:15:22Z",
- "dateOfPublishing": "2019-08-24T14:15:22Z",
- "isOnCentralDisk": true,
- "archiveStatusMessage": "string",
- "retrieveStatusMessage": "string",
- "archiveReturnMessage": { },
- "retrieveReturnMessage": { },
- "exportedTo": "string",
- "retrieveIntegrityCheck": true,
- "id": "string"
}, - "history": [
- {
- "id": "string"
}
], - "instrumentId": "string",
- "techniques": [
- {
- "pid": "string",
- "name": "string"
}
]
}| id required | string <JSON> Instrument id |
| fk required | string <JSON> Foreign key for datasets |
| pid required | string Persistent Identifier for datasets derived from UUIDv4 and prepended automatically by site specific PID prefix like 20.500.12345/ |
| owner required | string Owner of the data set, usually first name + lastname |
| ownerEmail | string Email of owner of the data set |
| orcidOfOwner | string ORCID of owner https://orcid.org if available |
| contactEmail required | string Email of contact person for this dataset |
| sourceFolder required | string Absolute file path on file server containing the files of this dataset, e.g. /some/path/to/sourcefolder. In case of a single file dataset, e.g. HDF5 data, it contains the path up to, but excluding the filename. Trailing slashes are removed. |
| sourceFolderHost | string DNS host name of file server hosting sourceFolder, optionally including protocol e.g. [protocol://]fileserver1.example.com |
| size | number <double> Total size of all source files contained in source folder on disk when unpacked |
| packedSize | number <double> Total size of all datablock package files created for this dataset |
| numberOfFiles | number <double> Total number of lines in filelisting of all OrigDatablocks for this dataset |
| numberOfFilesArchived | number <double> Total number of lines in filelisting of all Datablocks for this dataset |
| creationTime required | string <date-time> Time when dataset became fully available on disk, i.e. all containing files have been written. Format according to chapter 5.6 internet date/time format in RFC 3339. Local times without timezone/offset info are automatically transformed to UTC using the timezone of the API server. |
| type required | string Characterize type of dataset, either 'base' or 'raw' or 'derived'. Autofilled when choosing the proper inherited models |
| validationStatus | string Defines a level of trust, e.g. a measure of how much data was verified or used by other persons |
| keywords | Array of strings Array of tags associated with the meaning or contents of this dataset. Values should ideally come from defined vocabularies, taxonomies, ontologies or knowledge graphs |
| description | string Free text explanation of contents of dataset |
| datasetName | string A name for the dataset, given by the creator to carry some semantic meaning. Useful for display purposes e.g. instead of displaying the pid. Will be autofilled if missing using info from sourceFolder |
| classification | string ACIA information about AUthenticity,COnfidentiality,INtegrity and AVailability requirements of dataset. E.g. AV(ailabilty)=medium could trigger the creation of a two tape copies. Format 'AV=medium,CO=low' |
| license | string Name of license under which data can be used |
| version | string Version of API used in creation of dataset |
| isPublished | boolean Flag is true when data are made publically available |
| ownerGroup required | string Defines the group which owns the data, and therefore has unrestricted access to this data. Usually a pgroup like p12151 |
| accessGroups | Array of strings Optional additional groups which have read access to the data. Users which are member in one of the groups listed here are allowed to access this data. The special group 'public' makes data available to all users |
| createdBy | string Functional or user account name who created this instance |
| updatedBy | string Functional or user account name who last updated this instance |
| createdAt | string <date-time> |
| updatedAt | string <date-time> |
| publishedDataId | string |
| publisheddataId | string |
object (DatasetLifecycle) For each dataset there exists an embedded dataset lifecycle document which describes the current status of the dataset during its lifetime with respect to the storage handling systems | |
Array of objects (Message) | |
| instrumentId | string |
Array of objects (Technique) |
{- "pid": "string",
- "owner": "string",
- "ownerEmail": "string",
- "orcidOfOwner": "string",
- "contactEmail": "string",
- "sourceFolder": "string",
- "sourceFolderHost": "string",
- "size": 0,
- "packedSize": 0,
- "numberOfFiles": 0,
- "numberOfFilesArchived": 0,
- "creationTime": "2019-08-24T14:15:22Z",
- "type": "string",
- "validationStatus": "string",
- "keywords": [
- "string"
], - "description": "string",
- "datasetName": "string",
- "classification": "string",
- "license": "string",
- "version": "string",
- "isPublished": true,
- "ownerGroup": "string",
- "accessGroups": [
- "string"
], - "createdBy": "string",
- "updatedBy": "string",
- "createdAt": "2019-08-24T14:15:22Z",
- "updatedAt": "2019-08-24T14:15:22Z",
- "publishedDataId": "string",
- "publisheddataId": "string",
- "datasetlifecycle": {
- "archivable": true,
- "retrievable": true,
- "publishable": true,
- "dateOfDiskPurging": "2019-08-24T14:15:22Z",
- "archiveRetentionTime": "2019-08-24T14:15:22Z",
- "dateOfPublishing": "2019-08-24T14:15:22Z",
- "isOnCentralDisk": true,
- "archiveStatusMessage": "string",
- "retrieveStatusMessage": "string",
- "archiveReturnMessage": { },
- "retrieveReturnMessage": { },
- "exportedTo": "string",
- "retrieveIntegrityCheck": true,
- "id": "string"
}, - "history": [
- {
- "id": "string"
}
], - "instrumentId": "string",
- "techniques": [
- {
- "pid": "string",
- "name": "string"
}
]
}{- "pid": "string",
- "owner": "string",
- "ownerEmail": "string",
- "orcidOfOwner": "string",
- "contactEmail": "string",
- "sourceFolder": "string",
- "sourceFolderHost": "string",
- "size": 0,
- "packedSize": 0,
- "numberOfFiles": 0,
- "numberOfFilesArchived": 0,
- "creationTime": "2019-08-24T14:15:22Z",
- "type": "string",
- "validationStatus": "string",
- "keywords": [
- "string"
], - "description": "string",
- "datasetName": "string",
- "classification": "string",
- "license": "string",
- "version": "string",
- "isPublished": true,
- "ownerGroup": "string",
- "accessGroups": [
- "string"
], - "createdBy": "string",
- "updatedBy": "string",
- "createdAt": "2019-08-24T14:15:22Z",
- "updatedAt": "2019-08-24T14:15:22Z",
- "publishedDataId": "string",
- "publisheddataId": "string",
- "datasetlifecycle": {
- "archivable": true,
- "retrievable": true,
- "publishable": true,
- "dateOfDiskPurging": "2019-08-24T14:15:22Z",
- "archiveRetentionTime": "2019-08-24T14:15:22Z",
- "dateOfPublishing": "2019-08-24T14:15:22Z",
- "isOnCentralDisk": true,
- "archiveStatusMessage": "string",
- "retrieveStatusMessage": "string",
- "archiveReturnMessage": { },
- "retrieveReturnMessage": { },
- "exportedTo": "string",
- "retrieveIntegrityCheck": true,
- "id": "string"
}, - "history": [
- {
- "id": "string"
}
], - "instrumentId": "string",
- "techniques": [
- {
- "pid": "string",
- "name": "string"
}
]
}| id required | string <JSON> Instrument id |
| filter | string <JSON> |
[- {
- "pid": "string",
- "owner": "string",
- "ownerEmail": "string",
- "orcidOfOwner": "string",
- "contactEmail": "string",
- "sourceFolder": "string",
- "sourceFolderHost": "string",
- "size": 0,
- "packedSize": 0,
- "numberOfFiles": 0,
- "numberOfFilesArchived": 0,
- "creationTime": "2019-08-24T14:15:22Z",
- "type": "string",
- "validationStatus": "string",
- "keywords": [
- "string"
], - "description": "string",
- "datasetName": "string",
- "classification": "string",
- "license": "string",
- "version": "string",
- "isPublished": true,
- "ownerGroup": "string",
- "accessGroups": [
- "string"
], - "createdBy": "string",
- "updatedBy": "string",
- "createdAt": "2019-08-24T14:15:22Z",
- "updatedAt": "2019-08-24T14:15:22Z",
- "publishedDataId": "string",
- "publisheddataId": "string",
- "datasetlifecycle": {
- "archivable": true,
- "retrievable": true,
- "publishable": true,
- "dateOfDiskPurging": "2019-08-24T14:15:22Z",
- "archiveRetentionTime": "2019-08-24T14:15:22Z",
- "dateOfPublishing": "2019-08-24T14:15:22Z",
- "isOnCentralDisk": true,
- "archiveStatusMessage": "string",
- "retrieveStatusMessage": "string",
- "archiveReturnMessage": { },
- "retrieveReturnMessage": { },
- "exportedTo": "string",
- "retrieveIntegrityCheck": true,
- "id": "string"
}, - "history": [
- {
- "id": "string"
}
], - "instrumentId": "string",
- "techniques": [
- {
- "pid": "string",
- "name": "string"
}
]
}
]| id required | string <JSON> Instrument id |
| pid required | string Persistent Identifier for datasets derived from UUIDv4 and prepended automatically by site specific PID prefix like 20.500.12345/ |
| owner required | string Owner of the data set, usually first name + lastname |
| ownerEmail | string Email of owner of the data set |
| orcidOfOwner | string ORCID of owner https://orcid.org if available |
| contactEmail required | string Email of contact person for this dataset |
| sourceFolder required | string Absolute file path on file server containing the files of this dataset, e.g. /some/path/to/sourcefolder. In case of a single file dataset, e.g. HDF5 data, it contains the path up to, but excluding the filename. Trailing slashes are removed. |
| sourceFolderHost | string DNS host name of file server hosting sourceFolder, optionally including protocol e.g. [protocol://]fileserver1.example.com |
| size | number <double> Total size of all source files contained in source folder on disk when unpacked |
| packedSize | number <double> Total size of all datablock package files created for this dataset |
| numberOfFiles | number <double> Total number of lines in filelisting of all OrigDatablocks for this dataset |
| numberOfFilesArchived | number <double> Total number of lines in filelisting of all Datablocks for this dataset |
| creationTime required | string <date-time> Time when dataset became fully available on disk, i.e. all containing files have been written. Format according to chapter 5.6 internet date/time format in RFC 3339. Local times without timezone/offset info are automatically transformed to UTC using the timezone of the API server. |
| type required | string Characterize type of dataset, either 'base' or 'raw' or 'derived'. Autofilled when choosing the proper inherited models |
| validationStatus | string Defines a level of trust, e.g. a measure of how much data was verified or used by other persons |
| keywords | Array of strings Array of tags associated with the meaning or contents of this dataset. Values should ideally come from defined vocabularies, taxonomies, ontologies or knowledge graphs |
| description | string Free text explanation of contents of dataset |
| datasetName | string A name for the dataset, given by the creator to carry some semantic meaning. Useful for display purposes e.g. instead of displaying the pid. Will be autofilled if missing using info from sourceFolder |
| classification | string ACIA information about AUthenticity,COnfidentiality,INtegrity and AVailability requirements of dataset. E.g. AV(ailabilty)=medium could trigger the creation of a two tape copies. Format 'AV=medium,CO=low' |
| license | string Name of license under which data can be used |
| version | string Version of API used in creation of dataset |
| isPublished | boolean Flag is true when data are made publically available |
| ownerGroup required | string Defines the group which owns the data, and therefore has unrestricted access to this data. Usually a pgroup like p12151 |
| accessGroups | Array of strings Optional additional groups which have read access to the data. Users which are member in one of the groups listed here are allowed to access this data. The special group 'public' makes data available to all users |
| createdBy | string Functional or user account name who created this instance |
| updatedBy | string Functional or user account name who last updated this instance |
| createdAt | string <date-time> |
| updatedAt | string <date-time> |
| publishedDataId | string |
| publisheddataId | string |
object (DatasetLifecycle) For each dataset there exists an embedded dataset lifecycle document which describes the current status of the dataset during its lifetime with respect to the storage handling systems | |
Array of objects (Message) | |
| instrumentId | string |
Array of objects (Technique) |
{- "pid": "string",
- "owner": "string",
- "ownerEmail": "string",
- "orcidOfOwner": "string",
- "contactEmail": "string",
- "sourceFolder": "string",
- "sourceFolderHost": "string",
- "size": 0,
- "packedSize": 0,
- "numberOfFiles": 0,
- "numberOfFilesArchived": 0,
- "creationTime": "2019-08-24T14:15:22Z",
- "type": "string",
- "validationStatus": "string",
- "keywords": [
- "string"
], - "description": "string",
- "datasetName": "string",
- "classification": "string",
- "license": "string",
- "version": "string",
- "isPublished": true,
- "ownerGroup": "string",
- "accessGroups": [
- "string"
], - "createdBy": "string",
- "updatedBy": "string",
- "createdAt": "2019-08-24T14:15:22Z",
- "updatedAt": "2019-08-24T14:15:22Z",
- "publishedDataId": "string",
- "publisheddataId": "string",
- "datasetlifecycle": {
- "archivable": true,
- "retrievable": true,
- "publishable": true,
- "dateOfDiskPurging": "2019-08-24T14:15:22Z",
- "archiveRetentionTime": "2019-08-24T14:15:22Z",
- "dateOfPublishing": "2019-08-24T14:15:22Z",
- "isOnCentralDisk": true,
- "archiveStatusMessage": "string",
- "retrieveStatusMessage": "string",
- "archiveReturnMessage": { },
- "retrieveReturnMessage": { },
- "exportedTo": "string",
- "retrieveIntegrityCheck": true,
- "id": "string"
}, - "history": [
- {
- "id": "string"
}
], - "instrumentId": "string",
- "techniques": [
- {
- "pid": "string",
- "name": "string"
}
]
}{- "pid": "string",
- "owner": "string",
- "ownerEmail": "string",
- "orcidOfOwner": "string",
- "contactEmail": "string",
- "sourceFolder": "string",
- "sourceFolderHost": "string",
- "size": 0,
- "packedSize": 0,
- "numberOfFiles": 0,
- "numberOfFilesArchived": 0,
- "creationTime": "2019-08-24T14:15:22Z",
- "type": "string",
- "validationStatus": "string",
- "keywords": [
- "string"
], - "description": "string",
- "datasetName": "string",
- "classification": "string",
- "license": "string",
- "version": "string",
- "isPublished": true,
- "ownerGroup": "string",
- "accessGroups": [
- "string"
], - "createdBy": "string",
- "updatedBy": "string",
- "createdAt": "2019-08-24T14:15:22Z",
- "updatedAt": "2019-08-24T14:15:22Z",
- "publishedDataId": "string",
- "publisheddataId": "string",
- "datasetlifecycle": {
- "archivable": true,
- "retrievable": true,
- "publishable": true,
- "dateOfDiskPurging": "2019-08-24T14:15:22Z",
- "archiveRetentionTime": "2019-08-24T14:15:22Z",
- "dateOfPublishing": "2019-08-24T14:15:22Z",
- "isOnCentralDisk": true,
- "archiveStatusMessage": "string",
- "retrieveStatusMessage": "string",
- "archiveReturnMessage": { },
- "retrieveReturnMessage": { },
- "exportedTo": "string",
- "retrieveIntegrityCheck": true,
- "id": "string"
}, - "history": [
- {
- "id": "string"
}
], - "instrumentId": "string",
- "techniques": [
- {
- "pid": "string",
- "name": "string"
}
]
}| id required | string <JSON> Instrument id |
| where | string <JSON> Criteria to match model instances |
{- "count": 0
}Model instance data
| pid required | string Persistent Identifier derived from UUIDv4 |
| name required | string |
| customMetadata | object |
{- "pid": "string",
- "name": "string",
- "customMetadata": { }
}{- "pid": "string",
- "name": "string",
- "customMetadata": { }
}Model instance data
| pid required | string Persistent Identifier derived from UUIDv4 |
| name required | string |
| customMetadata | object |
{- "pid": "string",
- "name": "string",
- "customMetadata": { }
}{- "pid": "string",
- "name": "string",
- "customMetadata": { }
}Model instance data
| pid required | string Persistent Identifier derived from UUIDv4 |
| name required | string |
| customMetadata | object |
{- "pid": "string",
- "name": "string",
- "customMetadata": { }
}{- "pid": "string",
- "name": "string",
- "customMetadata": { }
}| filter | string <JSON> Filter defining fields, where, include, order, offset, and limit - must be a JSON-encoded string ( |
[- {
- "pid": "string",
- "name": "string",
- "customMetadata": { }
}
]Model instance data
| pid required | string Persistent Identifier derived from UUIDv4 |
| name required | string |
| customMetadata | object |
{- "pid": "string",
- "name": "string",
- "customMetadata": { }
}{- "pid": "string",
- "name": "string",
- "customMetadata": { }
}| where | string <JSON> Criteria to match model instances |
An object of model property name/value pairs
| pid required | string Persistent Identifier derived from UUIDv4 |
| name required | string |
| customMetadata | object |
{- "pid": "string",
- "name": "string",
- "customMetadata": { }
}{- "pid": "string",
- "name": "string",
- "customMetadata": { }
}| id required | string <JSON> Model id |
| filter | string <JSON> Filter defining fields and include - must be a JSON-encoded string ({"something":"value"}) |
{- "pid": "string",
- "name": "string",
- "customMetadata": { }
}| id required | string <JSON> Model id |
Model instance data
| pid required | string Persistent Identifier derived from UUIDv4 |
| name required | string |
| customMetadata | object |
{- "pid": "string",
- "name": "string",
- "customMetadata": { }
}{- "pid": "string",
- "name": "string",
- "customMetadata": { }
}| id required | string <JSON> Instrument id |
An object of model property name/value pairs
| pid required | string Persistent Identifier derived from UUIDv4 |
| name required | string |
| customMetadata | object |
{- "pid": "string",
- "name": "string",
- "customMetadata": { }
}{- "pid": "string",
- "name": "string",
- "customMetadata": { }
}| id required | string <JSON> Model id |
Model instance data
| pid required | string Persistent Identifier derived from UUIDv4 |
| name required | string |
| customMetadata | object |
{- "pid": "string",
- "name": "string",
- "customMetadata": { }
}{- "pid": "string",
- "name": "string",
- "customMetadata": { }
}| filter | string <JSON> Filter defining fields, where, include, order, offset, and limit - must be a JSON-encoded string ( |
{- "pid": "string",
- "name": "string",
- "customMetadata": { }
}| where | string <JSON> Criteria to match model instances |
An object of model property name/value pairs
| pid required | string Persistent Identifier derived from UUIDv4 |
| name required | string |
| customMetadata | object |
{- "pid": "string",
- "name": "string",
- "customMetadata": { }
}{- "count": 0
}